SyncComponentPrivatePtr Class Reference

Interface representing a Synchronization Component in a Test & Measurement system. A SynchronizationComponent ensures synchronization among measurement devices in the system. It can act as a sync source and/or as a sync output, with each component having one sync input and 0 to n sync outputs. More...

Inherits ObjectPtr< ISyncComponentPrivate >.

Detailed Description

Interface representing a Synchronization Component in a Test & Measurement system. A SynchronizationComponent ensures synchronization among measurement devices in the system. It can act as a sync source and/or as a sync output, with each component having one sync input and 0 to n sync outputs.

SynchronizationComponents are configured via interfaces, which can include PTP, IRIQ, GPS, and CLK sync interfaces, among others.

Note

Every SynchronizationComponent has at least one interface. Only one interface can be set as an input, while others can be used as sync outputs to synchronize other devices. The configuration of these interfaces and the reading of their status is defined in Part 4.

Depending on the setup, some interfaces may be switched off, and some interfaces may act as sync sources or outputs.

A CLK interface can be used to let a device run in Fre-Run mode, where the device syncs internally to an internal quartz.

Public Member Functions
void	setSyncLocked (daq::Bool synchronizationLocked) const
	Sets the synchronization lock status. More...
void	addInterface (const daq::PropertyObjectPtr &syncInterface) const
	Adds an interface to the synchronization component. More...
void	removeInterface (const daq::StringPtr &syncInterfaceName) const
	Removes an interface from the synchronization component. More...

Member Function Documentation

addInterface()

void addInterface ( const daq::PropertyObjectPtr &  syncInterface ) const

inline

Adds an interface to the synchronization component.

Parameters

interface

The interface to be added.

removeInterface()

void removeInterface ( const daq::StringPtr &  syncInterfaceName ) const

inline

Removes an interface from the synchronization component.

Parameters

interfaceName

The name of the interface to be removed.

setSyncLocked()

void setSyncLocked ( daq::Bool  synchronizationLocked ) const

inline

Sets the synchronization lock status.

Parameters

synchronizationLocked

True if synchronization is locked; false otherwise.