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...

Inheritance diagram for ISyncComponent:

Collaboration diagram for ISyncComponent:

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
virtual ErrCode INTERFACE_FUNC	getSyncLocked (Bool *synchronizationLocked)=0
	Retrieves the synchronization lock status. More...

virtual ErrCode INTERFACE_FUNC	getSelectedSource (Int *selectedSource)=0
	Retrieves the selected sync source interface. More...

virtual ErrCode INTERFACE_FUNC	setSelectedSource (Int selectedSource)=0
	Sets the selected sync source interface. More...

virtual ErrCode INTERFACE_FUNC	getInterfaces (IDict **interfaces)=0
	Retrieves the list of interfaces associated with this synchronization component. More...

Public Member Functions inherited from IComponent
virtual ErrCode INTERFACE_FUNC	getLocalId (IString **localId)=0
	Gets the local ID of the component. More...

virtual ErrCode INTERFACE_FUNC	getGlobalId (IString **globalId)=0
	Gets the global ID of the component. More...

virtual ErrCode INTERFACE_FUNC	getActive (Bool *active)=0
	Returns true if the component is active; false otherwise. More...

virtual ErrCode INTERFACE_FUNC	setActive (Bool active)=0
	Sets the component to be either active or inactive. Sets the local active state and notifies children about the parent active state change. More...

virtual ErrCode INTERFACE_FUNC	getContext (IContext **context)=0
	Gets the context object. More...

virtual ErrCode INTERFACE_FUNC	getParent (IComponent **parent)=0
	Gets the parent of the component. More...

virtual ErrCode INTERFACE_FUNC	getName (IString **name)=0
	Gets the name of the component. More...

virtual ErrCode INTERFACE_FUNC	setName (IString *name)=0
	Sets the name of the component. More...

virtual ErrCode INTERFACE_FUNC	getDescription (IString **description)=0
	Gets the description of the component. More...

virtual ErrCode INTERFACE_FUNC	setDescription (IString *description)=0
	Sets the description of the component. More...

virtual ErrCode INTERFACE_FUNC	getTags (ITags **tags)=0
	Gets the tags of the component. More...

virtual ErrCode INTERFACE_FUNC	getVisible (Bool *visible)=0
	Gets `visible` metadata state of the component. More...

virtual ErrCode INTERFACE_FUNC	setVisible (Bool visible)=0
	Sets `visible` attribute state of the component. More...

virtual ErrCode INTERFACE_FUNC	getLockedAttributes (IList **attributes)=0
	Gets a list of the component's locked attributes. The locked attributes cannot be modified via their respective setters. More...

virtual ErrCode INTERFACE_FUNC	getOnComponentCoreEvent (IEvent **event)=0
	Gets the Core Event object that triggers whenever a change to this component happens within the openDAQ core structure. More...

virtual ErrCode INTERFACE_FUNC	getStatusContainer (IComponentStatusContainer **statusContainer)=0
	Gets the container of Component statuses. More...

virtual ErrCode INTERFACE_FUNC	findComponent (IString id, IComponent *outComponent)=0
	Finds the component (signal/device/function block) with the specified (global) id. More...

virtual ErrCode INTERFACE_FUNC	getOperationMode (OperationModeType *modeType)=0
	Gets the operation mode of the device. More...

virtual ErrCode INTERFACE_FUNC	getLocalActive (Bool *localActive)=0
	Returns true if the component is local active; false otherwise. More...

virtual ErrCode INTERFACE_FUNC	getParentActive (Bool *parentActive)=0
	Returns true if the component's parent is active; false otherwise. More...

Public Member Functions inherited from IPropertyObject
virtual ErrCode INTERFACE_FUNC	getClassName (IString **className)=0
	Gets the name of the class the Property object was constructed with. More...

virtual ErrCode INTERFACE_FUNC	setPropertyValue (IString propertyName, IBaseObject value)=0
	Sets the value of the Property with the given name. More...

virtual ErrCode INTERFACE_FUNC	getPropertyValue (IString propertyName, IBaseObject *value)=0
	Gets the value of the Property with the given name. More...

virtual ErrCode INTERFACE_FUNC	getPropertySelectionValue (IString propertyName, IBaseObject *value)=0
	Gets the selected value of the Property, if the Property is a Selection property. More...

virtual ErrCode INTERFACE_FUNC	clearPropertyValue (IString *propertyName)=0
	Clears the Property value from the Property object. More...

virtual ErrCode INTERFACE_FUNC	hasProperty (IString propertyName, Bool hasProperty)=0
	Checks if the Property object contains a property named `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	getProperty (IString propertyName, IProperty *property)=0
	Gets the Property with the given `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	addProperty (IProperty *property)=0
	Adds the property to the Property object. More...

virtual ErrCode INTERFACE_FUNC	removeProperty (IString *propertyName)=0
	Removes the Property named `propertyName` from the Property object. More...

virtual ErrCode INTERFACE_FUNC	getOnPropertyValueWrite (IString propertyName, IEvent *event)=0
	Gets the Event that is triggered whenever a Property value is written to the Property named `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	getOnPropertyValueRead (IString propertyName, IEvent *event)=0
	Gets the Event that is triggered whenever a Property value of a Property named `propertyName` is read. More...

virtual ErrCode INTERFACE_FUNC	getOnAnyPropertyValueWrite (IEvent **event)=0
	Gets the Event that is triggered whenever any Property value is written. The event is triggered after the specific Property event. More...

virtual ErrCode INTERFACE_FUNC	getOnAnyPropertyValueRead (IEvent **event)=0
	Gets the Event that is triggered whenever any Property value is read.The event is triggered after the specific Property event. More...

virtual ErrCode INTERFACE_FUNC	getVisibleProperties (IList **properties)=0
	Returns a list of visible properties contained in the Property object. More...

virtual ErrCode INTERFACE_FUNC	getAllProperties (IList **properties)=0
	Returns a list of all properties contained in the Property object. More...

virtual ErrCode INTERFACE_FUNC	setPropertyOrder (IList *orderedPropertyNames)=0
	Sets a custom order of properties as defined in the list of property names. More...

virtual ErrCode INTERFACE_FUNC	beginUpdate ()=0
	Begins batch configuration of the object. More...

virtual ErrCode INTERFACE_FUNC	endUpdate ()=0
	Ends batch configuration of the object. More...

virtual ErrCode INTERFACE_FUNC	getUpdating (Bool *updating)=0
	Returns the state of batch configuration. More...

virtual ErrCode INTERFACE_FUNC	getOnEndUpdate (IEvent **event)=0
	Gets the Event that is triggered whenever the batch configuration is applied. More...

virtual ErrCode INTERFACE_FUNC	getPermissionManager (IPermissionManager **permissionManager)=0
	Gets the permission manager of property object. More...

virtual ErrCode INTERFACE_FUNC	findProperties (IList *properties, ISearchFilter propertyFilter, ISearchFilter *componentFilter=nullptr)=0
	Retrieves a list of properties from the Property object that match the given property filter. More...

virtual ErrCode INTERFACE_FUNC	setPropertySelectionValue (IString propertyName, IBaseObject value)=0
	Sets the value of a Selection property by the selection item value (e.g. string, float, or list/dict value). More...

virtual ErrCode INTERFACE_FUNC	clearPropertyValues ()=0
	Clears values of all properties contained in the Property object, including nested child properties. More...

Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...

virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...

virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...

virtual ErrCode INTERFACE_FUNC	equals (IBaseObject other, Bool equal) const =0
	Compares object to another object for equality. More...

virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...

Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...

virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...

virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

◆ getInterfaces()

virtual ErrCode INTERFACE_FUNC getInterfaces ( IDict ** interfaces )

pure virtual

Retrieves the list of interfaces associated with this synchronization component.

Parameters

[out] interfaces List of interfaces associated with this component.

◆ getSelectedSource()

virtual ErrCode INTERFACE_FUNC getSelectedSource ( Int * selectedSource )

pure virtual

Retrieves the selected sync source interface.

Parameters

[out] selectedSource The selected sync source interface.

◆ getSyncLocked()

virtual ErrCode INTERFACE_FUNC getSyncLocked ( Bool * synchronizationLocked )

pure virtual

Retrieves the synchronization lock status.

Parameters

[out] synchronizationLocked True if synchronization is locked; false otherwise.

◆ setSelectedSource()

virtual ErrCode INTERFACE_FUNC setSelectedSource ( Int selectedSource )

pure virtual

Sets the selected sync source interface.

Parameters

selectedSource The selected sync source interface.

Detailed Description

Public Member Functions

Member Function Documentation

◆ getInterfaces()

◆ getSelectedSource()

◆ getSyncLocked()

◆ setSelectedSource()