NI TCLK Attributes

TClk Attributes

• NITCLK_ATTRIBUTE_EXPORTED_SYNC_PULSE_OUTPUT_TERMINAL
• NITCLK_ATTRIBUTE_EXPORTED_TCLK_OUTPUT_TERMINAL
• NITCLK_ATTRIBUTE_PAUSE_TRIGGER_MASTER_SESSION
• NITCLK_ATTRIBUTE_REF_TRIGGER_MASTER_SESSION
• NITCLK_ATTRIBUTE_SAMPLE_CLOCK_DELAY
• NITCLK_ATTRIBUTE_SCRIPT_TRIGGER_MASTER_SESSION
• NITCLK_ATTRIBUTE_START_TRIGGER_MASTER_SESSION
• NITCLK_ATTRIBUTE_SEQUENCER_FLAG_MASTER_SESSION
• NITCLK_ATTRIBUTE_SYNC_PULSE_CLOCK_SOURCE
• NITCLK_ATTRIBUTE_SYNC_PULSE_SENDER_SYNC_PULSE_SOURCE
• NITCLK_ATTRIBUTE_SYNC_PULSE_SOURCE
• NITCLK_ATTRIBUTE_TCLK_ACTUAL_PERIOD

NITCLK_ATTRIBUTE_EXPORTED_SYNC_PULSE_OUTPUT_TERMINAL

Data Type:	ViString
Access:	Read/Write
Coercion:	None
High-level Functions:	niTClk_Synchronize
Description:	Specifies the destination of the Sync Pulse signal. Use this attribute to synchronize a multichassis system.
Valid Values
PXI Devices:	"PXI_Trig0" through "PXI_Trig7" and device-specific settings
PCI Devices:	"RTSI_0" through "RTSI_7" and device-specific settings
Examples of Device-specific Settings:	NI PXI-5122 supports "PFI0" and "PFI1"NI PXI-5421 supports "PFI0", "PFI1","PFI4", and "PFI5"NI PXI-6551/6552 supports "PFI0", "PFI1", "PFI2", and "PFI3"
Default Value:	Empty string. An empty string indicates that the signal is not exported.

NITCLK_ATTRIBUTE_EXPORTED_TCLK_OUTPUT_TERMINAL

Data Type:	ViString
Access:	Read/Write
Coercion:	None
High-level Functions:	None
Description:	Specifies the destination for the TClk signal of the device.

NITCLK_ATTRIBUTE_PAUSE_TRIGGER_MASTER_SESSION

Data Type:	ViSession
Access:	Read/Write
Coercion:	None
High-level Functions:	niTClk_ConfigureForHomogeneousTriggers
Description:	Specifies the Pause Trigger master session.For external triggers, the NI-TClk Pause Trigger Master Session is the session configured to receive an external trigger. For None (no trigger configured) or software triggers, the NI-TClk Pause Trigger Master Session is the session that generates the trigger.

NITCLK_ATTRIBUTE_REF_TRIGGER_MASTER_SESSION

Data Type:	ViSession
Access:	Read/Write
Coercion:	None
High-level Functions:	niTClk_ConfigureForHomogeneousTriggers
Description:	Specifies the Reference Trigger master session.For external triggers, the NI-TClk Reference Trigger Master Session is the session configured to receive an external trigger. For None (no trigger configured) or software triggers, the NI-TClk Reference Trigger Master Session is the session that generates the trigger.

NITCLK_ATTRIBUTE_SAMPLE_CLOCK_DELAY

Data Type:	ViReal64
Access:	Read/Write
Coercion:	None
High-level Functions:	None
Description:	Specifies the delay, in seconds, to apply to the session Sample Clock, relative to other synchronized sessions. During synchronization, NI-TClk aligns the Sample Clocks on the synchronized devices. If you want to delay the Sample Clocks, set this attribute before calling the niTClk_Synchronize function.
Default Value:	0

NITCLK_ATTRIBUTE_SCRIPT_TRIGGER_MASTER_SESSION

Data Type:	ViSession
Access:	Read/Write
Coercion:	None
High-level Functions:	niTClk_ConfigureForHomogeneousTriggers
Description:	Specifies the Script Trigger master session.For external triggers, the NI-TClk Script Trigger Master Session is the session configured to receive an external trigger. For None (no trigger configured) or software triggers, the NI-TClk Script Trigger Master Session is the session that generates the trigger.

NITCLK_ATTRIBUTE_START_TRIGGER_MASTER_SESSION

Data Type:	ViSession
Access:	Read/Write
Coercion:	None
High-level Functions:	niTClk_ConfigureForHomogeneousTriggers
Description:	Specifies the Start Trigger master session.For external triggers, the NI-TClk Start Trigger Master Session is the session configured to receive an external trigger. For None (no trigger configured) or software triggers, the NI-TClk Start Trigger Master Session is the session that generates the trigger.

NITCLK_ATTRIBUTE_SEQUENCER_FLAG_MASTER_SESSION

Data Type:	ViSession
Access:	Read/Write
Coercion:	None
High-level Functions:	niTClk_ConfigureForHomogeneousTriggers
Description:	Specifies the Sequencer Flag master session.For external triggers, the NI-TClk Sequencer Flag Master Session is the session configured to receive an external trigger. For None (no trigger configured) or software triggers, the NI-TClk Start Trigger Master Session is the session that generates the trigger.

NITCLK_ATTRIBUTE_SYNC_PULSE_CLOCK_SOURCE

Data Type:	ViString
Access:	Read/Write
Coercion:	None
High-level Functions:	niTClk_ConfigureForHomogeneousTriggers
Description:	Specifies the Sync Pulse Clock source. Use this attribute when you are synchronizing PCI devices and want to control RTSI 7 yourself. Ensure that a 10 MHz clock is driven onto the RTSI 7.
Valid Values
PXI Devices:	"PXI_CLK10" "None"
PCI Devices:	"RTSI_7" "None"
Default Value:	"None". "None" directs the niTClk_Synchronize function to create the necessary routes. For PCI, one of the synchronized devices drives a 10 MHz clock on the RTSI 7, unless RTSI 7 is already driven.

NITCLK_ATTRIBUTE_SYNC_PULSE_SENDER_SYNC_PULSE_SOURCE

Data Type:	ViString
Access:	Read/Write
Coercion:	None
High-level Functions:	None
Description:	Specifies the external sync pulse source of the Sync Pulse Sender. You can use this source to synchronize the Sync Pulse Sender with an external non-TCLK event.
Valid Values
PXI Devices:	"PXI_Trig0" through "PXI_Trig7" and device-specific settings
PCI Devices:	"RTSI_0" through "RTSI_7" and device-specific settings
Examples of Device-specific Settings:	NI PXI-5122 supports "PFI0" and "PFI1"NI PXI-5421 supports "PFI0", "PFI1", "PFI4", and "PFI5"NI PXI-6551/6552 supports "PFI0", "PFI1", "PFI2", and "PFI3"
Default Value:	Empty string. An empty string indicates that the signal is not exported.

NITCLK_ATTRIBUTE_SYNC_PULSE_SOURCE

Data Type:	ViString
Access:	Read/Write
Coercion:	None
High-level Functions:	niTClk_Synchronize
Description:	Specifies the Sync Pulse source. Use this attribute to synchronize a multichassis system.
Valid Values
PXI Devices:	"PXI_Trig0" through "PXI_Trig7" and device-specific settings
PCI Devices:	"RTSI_0" through "RTSI_7" and device-specific settings
Examples of Device-specific Settings:	NI PXI-5122 supports "PFI0" and "PFI1" NI PXI-5421 supports "PFI0", "PFI1", "PFI2", and "PFI3" NI PXI-6551/6552 supports "PFI0", "PFI1", "PFI2", and "PFI3"
Default Value:	Empty string. An empty string directs niTClk_Synchronize to set this attribute when all the synchronized devices are in one PXI chassis. To synchronize a multichassis system, you must set this attribute before calling the niTClk_Synchronize function.

NITCLK_ATTRIBUTE_TCLK_ACTUAL_PERIOD

Data Type:	ViReal64
Access:	Read Only
Coercion:	None
High-level Functions:	None
Description:	Returns the computed TClk period.