 |
openDAQ
Open data acquisition platform
|
|
openDAQ
Open data acquisition platform
|
If set, gives additional information about the reference domain. More...
Inheritance diagram for IReferenceDomainInfo: Collaboration diagram for IReferenceDomainInfo:If set, gives additional information about the reference domain.
Public Member Functions | |
| virtual ErrCode INTERFACE_FUNC | getReferenceDomainId (IString **referenceDomainId)=0 |
| Gets the Reference Domain ID. More... | |
| virtual ErrCode INTERFACE_FUNC | getReferenceDomainOffset (IInteger **referenceDomainOffset)=0 |
| Gets the Reference Domain Offset. More... | |
| virtual ErrCode INTERFACE_FUNC | getReferenceTimeProtocol (TimeProtocol *referenceTimeProtocol)=0 |
| Gets the value that indicates the Reference Time Source. More... | |
| virtual ErrCode INTERFACE_FUNC | getUsesOffset (UsesOffset *usesOffset)=0 |
| Gets the value that indicates if offset is used. 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... | |
Gets the Reference Domain ID.
| [out] | referenceDomainId | The Reference Domain ID. |
If set, gives the common identifier of one domain group. Signals with the same Reference Domain ID share a common synchronization source (all the signals in a group either come from the same device or are synchronized using a protocol, such as PTP, NTP, IRIG, etc.). Those signals can always be read together, implying that a Multi Reader can be used to read the signals if their sampling rates are compatible.
|
pure virtual |
Gets the Reference Domain Offset.
| [out] | referenceDomainOffset | The Reference Domain Offset. |
If set, denotes the offset in ticks that must be added to the domain values of the signal for them to be equal to that of the sync source. The sync source will always have an offset of 0. This offset is changed only if the sync source changes and should be kept at 0 otherwise, allowing clients to differentiate between data loss and resync events. Any device can choose to always keep the offset at 0, representing changes in the offset in the domain packet values instead. This implementation prevents clients from differentiating between errors (data loss) and resync events. Additionally, if the offset is not configured, clients have no way of detecting a resync event in the case of asynchronous signals.
|
pure virtual |
Gets the value that indicates the Reference Time Source.
| [out] | referenceTimeProtocol | The value that indicates the Reference Time Source. |
If not set to Unknown, the domain quantity is “time”, and the timestamps are absolute according to the chosen time standard. The possible values are Gps, Tai, and Utc. This field is used to determine if two signals with different Domain IDs can be read together. Signals that have configured a Reference Time Source are trusted to have absolute time stamps that correlate to the chosen time standard (eg. two separate PTP networks, both driven through GPS can be read together, as their absolute time is the same).
|
pure virtual |
Gets the value that indicates if offset is used.
| [out] | usesOffset | The value that indicates if offset is used. |
If False, a device will contain time jumps due to resync in the domain signal data.
1.9.1 
