Table Of Contents

XNET Read (State » Time » Trigger) (G Dataflow)

Last Modified: September 16, 2019

Reads the captured timestamp for an imported Time Trigger.

connector_pane_image
datatype_icon

session in

The session to read. This session is selected from the LabVIEW project or returned from XNET Create Session.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

timeout

The time to wait for the rising edge of Time Trigger. The timeout is a LabVIEW relative time, represented as 64-bit floating-point in units of seconds.

If timeout is positive, XNET Read (State Time Trigger) waits for the rising edge of Time Trigger, then returns the timestamps for that edge. If the edge does not occur prior to the timeout, an error is returned.

If timeout is negative, XNET Read (State Time Trigger) waits indefinitely for the rising edge of Time Trigger.

If timeout is zero, XNET Read (State Time Trigger) does not wait and immediately returns the timestamps, which are zero (invalid) if the rising edge of Time Trigger has not occurred.

This input is optional. The default value is 10.0 (10 seconds).

datatype_icon

session out

An output that is the same as session in, provided for use with subsequent nodes.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
datatype_icon

local time trigger

Returns the timestamp of first rising edge of the imported Time Trigger since it was armed.

The timestamp is a LabVIEW absolute time, using the local timescale. If Time Trigger has not encountered a rising edge since it was armed, local time trigger returns zero (an invalid timestamp).

datatype_icon

network time trigger

Returns the timestamp of first rising edge of the imported Time Trigger since it was armed.

The timestamp is a LabVIEW absolute time, using the network timescale. If Time Trigger has not encountered a rising edge since it was armed, local time trigger returns zero (an invalid timestamp).

datatype_icon

network synced?

Contains the value of the Synced property at the time that both timestamps are acquired, to specify whether the network timestamp is synchronized to the network (true) or not (false).

Description

When you use XNET Connect Terminals with destination terminal of TimeTrigger (i.e., imported), the Time Trigger captures absolute timestamps on the rising edge, and you read those timestamps using this node.

The imported Time Trigger is armed when you invoke XNET Connect Terminals, and Time Trigger is armed again on each subsequent invocation of XNET Read (State Time Trigger). After the Time Trigger is armed, the first rising edge after arming is captured for the subsequent XNET Read (State Time Trigger).

Where This Node Can Run:

Desktop OS: Windows

FPGA: Supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics