openDAQ
Open data acquisition platform
DeviceDomainPtr Class Reference

Contains information about the domain of the device. More...

Inherits ObjectPtr< IDeviceDomain >.

Detailed Description

Contains information about the domain of the device.

The device domain contains a general view into the device's domain data. While devices most often operate in the time domain, this interface allows for description of any other domain commonly used in signal processing. For example, common domains include the angle domain, frequency domain, the spatial domain, and the wavelet domain.

The device domain allows for users to query a device for its current domain value via getTicksSinceOrigin and convert that into its domain unit by multiplying the tick count with the resolution. To get the absolute domain value, we can then also add the value to the Origin, which is most often provided as a time epoch in the ISO 8601 format.

Note that all devices might note provide a device domain implementation. Such devices cannot be directly queried for their domain data. In such a case, the domain data can be obtained through the device's output signals.

Public Member Functions

daq::RatioPtr getTickResolution () const
 Gets domain (usually time) between two consecutive ticks. Resolution is provided in a domain unit. More...
 
daq::StringPtr getOrigin () const
 Gets the device's absolute origin. Most often this is a time epoch in the ISO 8601 format. More...
 
daq::UnitPtr getUnit () const
 Gets the domain unit (eg. seconds, hours, degrees...) More...
 
daq::ReferenceDomainInfoPtr getReferenceDomainInfo () const
 Gets the Reference Domain Info. More...