C++ Reference

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- namespace HP::Omnicept | namespace HP::Omnicept::Abi | namespace HP::Omnicept::Utils | class HP::Omnicept::Glia::AsyncClientBuilder | A single use object that builds a Client connected to the HP Omnicept Runtime asynchronously. class ClientBuildHelpers | Utility class to take an asynchoronously building HP::Omnicept::Client and finishes building it, handling all exceptions that may get thrown. class Semaphore | class SessionLicenseHelper | Utility class to prompt the user for formatted license input, and parse an HP::Omnicept::Abi::SessionLicense from command line arguments. struct ClientBuildHelpers::BuildResult | Stores the result of HP::Omnicept::Glia::AsyncClientBuilder::getBuildClientResultOrThrow. struct HP::Omnicept::Client::LastValueCached | struct representing the result of Client::getLastData<DomainType>() struct HP::Omnicept::Abi::TimestampCalculator::NextTimestampResult | struct HP::Omnicept::Abi::TimestampCalculator::PacketTimeInfo |



namespace HP::Omnicept {#namespace_h_p_1_1_omnicept}

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- class HP::Omnicept::Glia | Entry point in to the HP Omnicept SDK. class HP::Omnicept::Client | Used to receive and send messages to/from the HP Omnicept Runtime.



class HP::Omnicept::Glia {#class_h_p_1_1_omnicept_1_1_glia}

Entry point in to the HP Omnicept SDK.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public Glia() = delete |


Members

public Glia() = delete {#class_h_p_1_1_omnicept_1_1_glia_1a61d7554025b3664c82fe6ef19ec95719}



class HP::Omnicept::Client {#class_h_p_1_1_omnicept_1_1_client}

class HP::Omnicept::Client
  : public HP::Omnicept::Utils::ThreadOwner

Used to receive and send messages to/from the HP Omnicept Runtime.

Has an internal thread that monitors incoming messages. When a message is received the Client caches it as the most recent value for the message's type, and executes a callback function mapped to the message's type

A separate callback is executed when a Client's state is changed which can be done by request or by signals receive from the HP Omnicept Runtime.

The internal thread will run until the client is destroyed or disconnected from the HP Omnicept Runtime.

To start receving messages after construction a Client must set a subscription to the messages it wants, via setSubscriptions, and call startClient

A Client can receive the following message types:

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public virtual ~Client() | public Result startClient() | If the Client's State is State::PAUSED changes the Client's State to State::RUNNING. public Result pauseClient() | If the Client's State is State::RUNNING changes the Client's State to State::PAUSED. public Result disconnectClient() | If the Client's State is not State::DISCONNECTED changes the Client's State to State::DISCONNECTED. public template<>
Result registerCallback(std::function< void(std::shared_ptr< DomainType >)> callback) | Takes a DomainType as a template parameter and a function to be called when a DomainType message is received from the HP Omnicept Runtime. public template<>
inline Result unregisterCallback() | Takes a DomainType as a template parameter and unregisters the function to be called for a specific DomainType. public template<>
inline bool isCallbackRegisteredForType() | Takes a DomainType as a template parameter and checks if a callback function is registered for the specified DomainType. public void clearAllCallbacks() | Clears all registered callbacks. public template<>
LastValueCached< DomainType > getLastData() | Takes a DomainType as a template parameter and returns the last value received of that DomainType. public Result startDataRecord(std::function< void(std::shared_ptr< Abi::DataVaultResult >)> dvrCallback) | Start recording all DomainType messages data send to HP Omnicept Runtime. public Result stopDataRecord() | Stop recording all DomainType messages data send to HP Omnicept Runtime. public State getClientState() const | Gets the current State of the Client. public Result setSubscriptions(const Abi::SubscriptionList & subList) | Tells the Client what messages to ask the HP Omnicept Runtime for. enum State | Enum representing the state of the Client. enum Result | Enum representing a result from operations on the Client The success of some operations are dependent on the Client's Client::State. typedef StateCallback_T |


Members

public virtual ~Client() {#class_h_p_1_1_omnicept_1_1_client_1a769e3eb3b9d0e9c0aee076cffb25eaea}

public Result startClient() {#class_h_p_1_1_omnicept_1_1_client_1aad65e1190ffae771fd56614a515abfed}

If the Client's State is State::PAUSED changes the Client's State to State::RUNNING.

This should not be confused with the inherited function Utils::ThreadOwner::start(), which can be ignored.

Returns

result which will be:

public Result pauseClient() {#class_h_p_1_1_omnicept_1_1_client_1ac7253edb56ee94644ab2e38e3c8fa740}

If the Client's State is State::RUNNING changes the Client's State to State::PAUSED.

Returns

result which will be:

public Result disconnectClient() {#class_h_p_1_1_omnicept_1_1_client_1ad210b92b5842948ccdb245d028ced3d5}

If the Client's State is not State::DISCONNECTED changes the Client's State to State::DISCONNECTED.

If the Client's State was changed the state callback will be called

Returns

result which will be:

public template<>
Result registerCallback(std::function< void(std::shared_ptr< DomainType >)> callback) {#class_h_p_1_1_omnicept_1_1_client_1af4b60f2f7f7ebb5c452bf461e1d5bf1e}

Takes a DomainType as a template parameter and a function to be called when a DomainType message is received from the HP Omnicept Runtime.

If a callback already exists for DomainType it will silently be overwritten

Parameters

  • DomainType the type of message the callback will receives

Parameters

  • callback the function pointer

Returns

result which will be:

public template<>
inline Result unregisterCallback() {#class_h_p_1_1_omnicept_1_1_client_1a00c88533101f74e4d69352d2a3840b77}

Takes a DomainType as a template parameter and unregisters the function to be called for a specific DomainType.

Parameters

  • DomainType The message type of the callback to remove

Returns

result which will be:

public template<>
inline bool isCallbackRegisteredForType() {#class_h_p_1_1_omnicept_1_1_client_1ac03226087ba1d04178caa9524958aa05}

Takes a DomainType as a template parameter and checks if a callback function is registered for the specified DomainType.

Parameters

  • DomainType A type of message

Returns

true if there is a callback registered for DomainType, else false

public void clearAllCallbacks() {#class_h_p_1_1_omnicept_1_1_client_1aca36b2b164a743b46d912bb26bd84f20}

Clears all registered callbacks.

public template<>
LastValueCached< DomainType > getLastData() {#class_h_p_1_1_omnicept_1_1_client_1af0afdcbf1f7e1c53c74da1311128b76f}

Takes a DomainType as a template parameter and returns the last value received of that DomainType.

Parameters

Exceptions

  • [Abi::SerializationError](#class_h_p_1_1_omnicept_1_1_abi_1_1_serialization_error) when the message is malformed

Returns

LastValueCached for DomainType. If LastValueCached.valid is false the Client has yet to receive a message of DomainType, and LastValueCached.data will have DomainType's default constructed values.

public Result startDataRecord(std::function< void(std::shared_ptr< Abi::DataVaultResult >)> dvrCallback) {#class_h_p_1_1_omnicept_1_1_client_1a166fe79bb4c833fb98a0921d871fefe1}

Start recording all DomainType messages data send to HP Omnicept Runtime.

Parameters

  • dvrCallback a callback to be registered for Abi::DataVaultResult messages received from the HP Omnicept Runtime

Returns

result which will be:

public Result stopDataRecord() {#class_h_p_1_1_omnicept_1_1_client_1accaad299297c279083e43e79ecbed23f}

Stop recording all DomainType messages data send to HP Omnicept Runtime.

Returns

result which will be:

public State getClientState() const {#class_h_p_1_1_omnicept_1_1_client_1ae70cd0b6d88ebbc8669be95913070ae0}

Gets the current State of the Client.

Returns

the Client's State

public Result setSubscriptions(const Abi::SubscriptionList & subList) {#class_h_p_1_1_omnicept_1_1_client_1a711325aa5b129c8e6b84c9814b230406}

Tells the Client what messages to ask the HP Omnicept Runtime for.

If you subscribe to messages that you don't have the correct license for, you will not receive them.

The Client's default Abi::SubscriptionList is set Abi::SubscriptionList::GetSubscriptionListToNone(), and no messages will be received until one is set. Setting subscriptions happens asynchronously, so there will be a small delay between setting the subscriptions and receiving messages you subscribed to.

Parameters

  • subList the messages the Client should ask to receive

Returns

result which will be:

enum State {#class_h_p_1_1_omnicept_1_1_client_1a55c58cd08c03a0e48f9b7efb319ce64b}

Values | Descriptions
--------------------------------|--------------------------------------------- PAUSED | The Client is connected but it is not currently receiving data.
This is the state the Client will be in after construction. Or after Client::pauseClient() is called successfully.
The Client's message callback's will not be called, nor will its lvc be updated while paused. RUNNING | The Client is connected and is currently receiving messages
This is the state the Client will be in after Client::startClient() is called successfully. DISCONNECTED | The Client is disconnected. This is the terminal state of a Client.
Once a Client is disconnected, it cannot be reconnected, a new Client has to be made.
A disconnection can happen by user request, when Client::disconnectClient() is called, or or by the HP Omnicept Runtime disconnecting from the Client.

Enum representing the state of the Client.

enum Result {#class_h_p_1_1_omnicept_1_1_client_1af313d808e1a3edf1eb6f7a4be501ae29}

Values | Descriptions
--------------------------------|--------------------------------------------- SUCCESS | The Client operation was successful. ERROR_CLIENT_DISCONNECTED | The operation was unsuccessful because the Client's state is Client::State::DISCONNECTED. NO_OP_CLIENT_RUNNING | The operation was not executed because the Client's state is Client::State::RUNNING. NO_OP_CLIENT_PAUSED | The operation was not executed because the Client's state is Client::State::PAUSED. UNSPECIFIED_ERROR | The operation was not unsuccessful due to a function specific error.

Enum representing a result from operations on the Client The success of some operations are dependent on the Client's Client::State.

typedef StateCallback_T {#class_h_p_1_1_omnicept_1_1_client_1a3ffccf4ef76a5c4d91acdfb79ad647ef}



namespace HP::Omnicept::Abi {#namespace_h_p_1_1_omnicept_1_1_abi}

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- enum CognitiveLoadTargetModel | enum ConfigurationErrorCode_t | enum DataVaultResultType | enum DataVaultResultErrorType | enum WhichEye | enum LicensingModel | enum representing Licensing Model for Omnicept enum MessageType | enum ModuleControlSignalType | enum representing types of ModuleControlSignal public std::ostream & operator<<(std::ostream & out,const BackpackColorZone &) | public std::ostream & operator<<(std::ostream & out,const Battery &) | public std::ostream & operator<<(std::ostream & out,const ByteMessage &) | public std::ostream & operator<<(std::ostream & out,const CameraImage &) | public std::ostream & operator<<(std::ostream & out,const CognitiveLoad &) | public std::ostream & operator<<(std::ostream & out,const NDimArrayFloat &) | public std::ostream & operator<<(std::ostream & out,const CognitiveLoadInputFeature &) | public std::ostream & operator<<(std::ostream & out,const HP::Omnicept::Abi::ConnectionIdentifier & cId) | public bool operator==(const ConnectionIdentifier & lhs,const std::string & rhs) | public bool operator!=(const ConnectionIdentifier & lhs,const std::string & rhs) | public bool operator<(const ConnectionIdentifier & lhs,const std::string & rhs) | public bool operator>(const ConnectionIdentifier & lhs,const std::string & rhs) | public bool operator<=(const ConnectionIdentifier & lhs,const std::string & rhs) | public bool operator>=(const ConnectionIdentifier & lhs,const std::string & rhs) | public template<>
std::ostream & operator<<(std::ostream & out,const DataFrame< T > & f) | public std::ostream & operator<<(std::ostream & out,const DataVaultResult & bvr) | public std::ostream & operator<<(std::ostream & out,const EyePupilDiameter & epd) | public std::ostream & operator<<(std::ostream & out,const EyePupillometry & ep) | public std::ostream & operator<<(std::ostream & out,const EyeGaze & eg) | public std::ostream & operator<<(std::ostream & out,const PupilPosition & ep) | public std::ostream & operator<<(std::ostream & out,const EyeTracking & et) | public std::ostream & operator<<(std::ostream & out,const HeartRate &) | public std::ostream & operator<<(std::ostream & out,const HeartRateVariability &) | public std::ostream & operator<<(std::ostream & out,const IMU3AxisValues & imu3ax) | public std::ostream & operator<<(std::ostream & out,const IMU &) | public std::ostream & operator<<(std::ostream & out,const PPG &) | public std::ostream & operator<<(std::ostream & out,const PPGFrame &) | public std::ostream & operator<<(std::ostream & out,const SceneColor &) | public std::ostream & operator<<(std::ostream & out,const SceneColorFrame &) | public std::ostream & operator<<(std::ostream & out,const VSync &) | class HP::Omnicept::Abi::BackpackColorZone | class HP::Omnicept::Abi::BackpackColors | class HP::Omnicept::Abi::Battery | Domain type for battery data. class HP::Omnicept::Abi::ByteMessage | Domain type for byte message data. class HP::Omnicept::Abi::CameraImage | Domain type for Camera Image data. class HP::Omnicept::Abi::CognitiveLoad | Domain type for Cognitive Load prediction. class HP::Omnicept::Abi::NDimArrayFloat | class HP::Omnicept::Abi::CognitiveLoadInputFeature | Domain type for Cognitive Load Input Feature data. class HP::Omnicept::Abi::ConfigurationError | Used for problems with accessing or performing operations on configuration files and values. class HP::Omnicept::Abi::ConnectionError | Used for problems in connection, meaning that the underlying connection mechanism failed. class HP::Omnicept::Abi::ConnectionIdentifier | A unique identifier for each connection in HP Omnicept. class HP::Omnicept::Abi::DataFrame | Base class for framed DomainData. Includes a templated collection for the framed type. Framed data is a sequence of values that are collected over a period of time and processed as a unit, usually for efficiency purposes. A DataFrame contains one or more T data and a timestamp that represents the latest data. class HP::Omnicept::Abi::DataVaultResult | A composite message to indicate DataVault recording result from a request to start or stop a DataVault recording. class HP::Omnicept::Abi::Dependency | Domain type for a Dependency. class HP::Omnicept::Abi::DependencyList | Domain type for a DependencyList. class HP::Omnicept::Abi::DomainData | Base class for filterable timestamped domain type data. class HP::Omnicept::Abi::EyePupilDiameter | Domain type for eye pupil data. class HP::Omnicept::Abi::EyePupillometry | Domain type for both eye's eye pupil data. class HP::Omnicept::Abi::EyePupillometryFrame | Domain type for EyePupillometry frame data. class HP::Omnicept::Abi::EyeTracking | Domain type for eye tracking data. class HP::Omnicept::Abi::EyeTrackingFrame | Domain type for EyeTracking frame data. class HP::Omnicept::Abi::GenericMessage | Base class for all domain types. class HP::Omnicept::Abi::HandshakeError | Used for failures during the the handshake that attempts to create a connection between a client and the HP Omnicept Runtime. class HP::Omnicept::Abi::HeartRate | Domain type for heart rate data. class HP::Omnicept::Abi::HeartRateFrame | Domain type for HeartRate Frames. class HP::Omnicept::Abi::HeartRateVariability | Domain type for heart rate variability data. class HP::Omnicept::Abi::IMessage | ABC for all messages, the intermediate step between domain types and serialized bytes. class HP::Omnicept::Abi::IMU3AxisValues | class HP::Omnicept::Abi::IMU | Domain type for inertial measurement unit (IMU) data. class HP::Omnicept::Abi::IMUFrame | Domain type for IMU Frames. class HP::Omnicept::Abi::MessageTypeUtils | class HP::Omnicept::Abi::ModuleControlSignal | Domain type for status signals between the HP Omnicept Runtime and its connections. class HP::Omnicept::Abi::PPG | Domain type for photoplethysmography (PPG) data. class HP::Omnicept::Abi::PPGFrame | Domain type for PPG Frames. class HP::Omnicept::Abi::ProtocolError | Used for problems in protocol, meaning that the wrong kinds of messages are seen, or they are observed in the wrong order. class HP::Omnicept::Abi::EyeSceneColors | Domain type for eye average color and brightness. class HP::Omnicept::Abi::SceneColor | Domain type for HMD average color and brightness. class HP::Omnicept::Abi::SceneColorFrame | Domain type for Framed SceneColors. class HP::Omnicept::Abi::SensorDeviceId | Uniquely identifies a sensor. class HP::Omnicept::Abi::SensorInfo | Uniquely identifies a sensor and provides filterable or configurable information about it. class HP::Omnicept::Abi::SerializationError | Used for problems in serialization, meaning that a domain type could not be serialized/deserialized or that a nullptr was given. class HP::Omnicept::Abi::SessionLicense | Session license information. class HP::Omnicept::Abi::Subscription | A Subscription is submitted to the HP Omnicept Runtime as part of a SubsriptionList to indicate that an extension wants to receive certain message types. class HP::Omnicept::Abi::SubscriptionList | Domain type for a SubscriptionList. class HP::Omnicept::Abi::Timestamp | Specifies the timestamp collection. class HP::Omnicept::Abi::TimestampCalculator | Utility class to handle calculation of interpolated HW timestamps and OmniceptTimestamp. class HP::Omnicept::Abi::TransportError | Used for problems in transport, meaning that the underlying transport mechanism could not send or receive bytes. class HP::Omnicept::Abi::VSync | Domain type for time facial camera shutter is open. struct HP::Omnicept::Abi::EyeGaze | Domain type for a normalized eye gaze vector. struct HP::Omnicept::Abi::PupilPosition | Domain type for pupil position. Normailzed to a [0.f,1.f] 2d coordinate system. struct HP::Omnicept::Abi::Color | Struct containing RGB and luminance values.

Members

enum CognitiveLoadTargetModel {#namespace_h_p_1_1_omnicept_1_1_abi_1a690eace6c7624c40eae6b9d71d47eaaa}

Values | Descriptions
--------------------------------|--------------------------------------------- UNKNOWN | EYE_TRACKING | EYE_TRACKING_PPG |

enum ConfigurationErrorCode_t {#namespace_h_p_1_1_omnicept_1_1_abi_1a6ef31e248b8ff28c59f6b4338b74e371}

Values | Descriptions
--------------------------------|--------------------------------------------- UNKNOWN_ERROR | FILE_NOT_FOUND | FILE_PATH_OVERFLOW | FILE_ACCESS_DENIED | FILE_CLOSE_FAILED | FILE_CORRUPTED | ATTRIBUTE_NOT_FOUND | ATTRIBUTE_WRITE_FAILED | ATTRIBUTE_NAME_INVALID | ATTRIBUTE_DELETE_FAILED | ATTRIBUTE_VALUE_OVERFLOW | ATTRIBUTE_VALUE_CORRUPTED |

enum DataVaultResultType {#namespace_h_p_1_1_omnicept_1_1_abi_1ab36757b7e67ac65b2b53bfc1fba793c0}

Values | Descriptions
--------------------------------|--------------------------------------------- UNKNOWN | RECORDING_STARTED | RECORDING_START_REJECTED | RECORDING_STOPPED | RECORDING_STOP_REJECTED | RECORDING_ERROR |

enum DataVaultResultErrorType {#namespace_h_p_1_1_omnicept_1_1_abi_1a670669ea69124fe2a5e7e966f6c762cc}

Values | Descriptions
--------------------------------|--------------------------------------------- UNKNOWN_ERROR | SUCCESS_NO_ERROR | INVALID_LICENSE_ERROR | CONNECTION_FAILED_ERROR | CONNECTION_NEGOTIATING_ERROR | RECORDING_HAS_ALREADY_STARTED_ERROR | RECORDING_HAS_NOT_STARTED_ERROR | RECORDING_STOP_NO_PERMISSON_ERROR |

enum WhichEye {#namespace_h_p_1_1_omnicept_1_1_abi_1a0131b0a5da0321e68d0efb32c1f88088}

Values | Descriptions
--------------------------------|--------------------------------------------- unknown | left | right | both |

enum LicensingModel {#namespace_h_p_1_1_omnicept_1_1_abi_1ad5b3af9007d6ee6e0884105964b1a006}

Values | Descriptions
--------------------------------|--------------------------------------------- UNKNOWN | Invalid LicensingModel. CORE | Licensing model for Core licenses. TRIAL | Licensing model for Trial licenses. ENTERPRISE | Licensing model for Enterprise licenses. REV_SHARE | Licensing model for Rev Share licenses. Alias for Developer and Academic licenses.

enum representing Licensing Model for Omnicept

enum MessageType {#namespace_h_p_1_1_omnicept_1_1_abi_1a911df77bbb8f1dabd8a583ba77a4f3af}

Values | Descriptions
--------------------------------|--------------------------------------------- null | declaration | testPackage | heartRate | heartRateFrame | sessionControlSignal | moduleControlSignal | eyeTracking | eyeTrackingFrame | backpackColors | battery | sync | eyePupillometry | eyePupillometryFrame | byteMessage | ppg | ppgFrame | cognitiveLoad | cognitiveLoadInputFeature | timestamp | subscriptionList | connectionParameter | vsync | sceneColor | sceneColorFrame | dataVaultAction | dataVaultResult | connectionStatusSignal | connectionInfo | connectionInfoQuery | heartRateVariability | cameraImage | imu | imuFrame |

enum ModuleControlSignalType {#namespace_h_p_1_1_omnicept_1_1_abi_1afc14bb092e02a2e361a933821d799eb2}

Values | Descriptions
--------------------------------|--------------------------------------------- MODULE_SIGNAL_UNKNOWN | This indicates that the ModuleControlSignal does not contain a usable signal type. This can happen if the type was not set properly, or if the message type is not known to the receiver, such as if there is a version mismatch. MODULE_SIGNAL_READY | Used to indicate that a connection being set up to the HP Omnicept Runtime has been finalized, and is ready to use. MODULE_SIGNAL_STOP | Used to notify that an existing connection to the HP Omnicept Runtime will be disconnected. Could be generated by either the local or remote side of the connection. MODULE_SIGNAL_WAKE | > Exclusively sent to internal connections. MODULE_SIGNAL_SLEEP | > Exclusively sent to internal connections.

enum representing types of ModuleControlSignal

public std::ostream & operator<<(std::ostream & out,const BackpackColorZone &) {#namespace_h_p_1_1_omnicept_1_1_abi_1a5a826102cadaea4a590727bbeb961aa0}

public std::ostream & operator<<(std::ostream & out,const Battery &) {#namespace_h_p_1_1_omnicept_1_1_abi_1ab860edcb2add78a6c07da4d26269d85a}

public std::ostream & operator<<(std::ostream & out,const ByteMessage &) {#namespace_h_p_1_1_omnicept_1_1_abi_1a4e2445afc71ed13d5df8edfac430fa73}

public std::ostream & operator<<(std::ostream & out,const CameraImage &) {#namespace_h_p_1_1_omnicept_1_1_abi_1a092026e77e618218e16e9282ec7757c9}

public std::ostream & operator<<(std::ostream & out,const CognitiveLoad &) {#namespace_h_p_1_1_omnicept_1_1_abi_1a3c3845ac9446a4f916f0d09afebd6a6a}

public std::ostream & operator<<(std::ostream & out,const NDimArrayFloat &) {#namespace_h_p_1_1_omnicept_1_1_abi_1aa1044a9a106b0d5ea54a81858e153b0d}

public std::ostream & operator<<(std::ostream & out,const CognitiveLoadInputFeature &) {#namespace_h_p_1_1_omnicept_1_1_abi_1a027569ef44ee8e055489ed0b5c75a1fd}

public std::ostream & operator<<(std::ostream & out,const HP::Omnicept::Abi::ConnectionIdentifier & cId) {#namespace_h_p_1_1_omnicept_1_1_abi_1a4f6e0c75bc569fd45c3d8fdfcd569292}

public bool operator==(const ConnectionIdentifier & lhs,const std::string & rhs) {#namespace_h_p_1_1_omnicept_1_1_abi_1a9627c6c12e21eb94849147b0e961b382}

public bool operator!=(const ConnectionIdentifier & lhs,const std::string & rhs) {#namespace_h_p_1_1_omnicept_1_1_abi_1a30a549bb0af15e4ebd04f1cd3fe223be}

public bool operator<(const ConnectionIdentifier & lhs,const std::string & rhs) {#namespace_h_p_1_1_omnicept_1_1_abi_1a34404a5939b0ec83f4be2ed7c4ea6412}

public bool operator>(const ConnectionIdentifier & lhs,const std::string & rhs) {#namespace_h_p_1_1_omnicept_1_1_abi_1af9268b46de13659bf70e54b45bac52de}

public bool operator<=(const ConnectionIdentifier & lhs,const std::string & rhs) {#namespace_h_p_1_1_omnicept_1_1_abi_1a1c74a5e7126ad08695f2a160ff92e7a0}

public bool operator>=(const ConnectionIdentifier & lhs,const std::string & rhs) {#namespace_h_p_1_1_omnicept_1_1_abi_1aaf014a5c883435859d619a07aac6388d}

public template<>
std::ostream & operator<<(std::ostream & out,const DataFrame< T > & f) {#namespace_h_p_1_1_omnicept_1_1_abi_1aa9a6446f6e29e84087c8577204ea8068}

public std::ostream & operator<<(std::ostream & out,const DataVaultResult & bvr) {#namespace_h_p_1_1_omnicept_1_1_abi_1ac23bb2f001d7a112b714a87e14f9393f}

public std::ostream & operator<<(std::ostream & out,const EyePupilDiameter & epd) {#namespace_h_p_1_1_omnicept_1_1_abi_1a436c28fa32d7f936c27923f228099abb}

public std::ostream & operator<<(std::ostream & out,const EyePupillometry & ep) {#namespace_h_p_1_1_omnicept_1_1_abi_1aa4daa7326744f311636e6583dd4f8b28}

public std::ostream & operator<<(std::ostream & out,const EyeGaze & eg) {#namespace_h_p_1_1_omnicept_1_1_abi_1a7f90c313ecca9b653902baabd1ef88e0}

public std::ostream & operator<<(std::ostream & out,const PupilPosition & ep) {#namespace_h_p_1_1_omnicept_1_1_abi_1a9295cc28a91d0742e054af7a976c873d}

public std::ostream & operator<<(std::ostream & out,const EyeTracking & et) {#namespace_h_p_1_1_omnicept_1_1_abi_1a3f59ab5ec59c2571729875a3ec5bcf92}

public std::ostream & operator<<(std::ostream & out,const HeartRate &) {#namespace_h_p_1_1_omnicept_1_1_abi_1aa3008c68d69e69afd3f0e3c01377746b}

public std::ostream & operator<<(std::ostream & out,const HeartRateVariability &) {#namespace_h_p_1_1_omnicept_1_1_abi_1a9ca6bca72ea5824ff817742e84a5bb34}

public std::ostream & operator<<(std::ostream & out,const IMU3AxisValues & imu3ax) {#namespace_h_p_1_1_omnicept_1_1_abi_1aaf6e3440277b9015f519edea9dc65faa}

public std::ostream & operator<<(std::ostream & out,const IMU &) {#namespace_h_p_1_1_omnicept_1_1_abi_1ad92949332d0b37843da517b20da78fa6}

public std::ostream & operator<<(std::ostream & out,const PPG &) {#namespace_h_p_1_1_omnicept_1_1_abi_1ae971ab4e68336cd0d9b9f6aefb11ab1c}

public std::ostream & operator<<(std::ostream & out,const PPGFrame &) {#namespace_h_p_1_1_omnicept_1_1_abi_1a2a7a669df7c2a4b2bf386cf4f01e5a79}

public std::ostream & operator<<(std::ostream & out,const SceneColor &) {#namespace_h_p_1_1_omnicept_1_1_abi_1ad28c7cbb7842a434f13c97e7ee2d92e3}

public std::ostream & operator<<(std::ostream & out,const SceneColorFrame &) {#namespace_h_p_1_1_omnicept_1_1_abi_1af27a430a42ed8ca2661afd1473876269}

public std::ostream & operator<<(std::ostream & out,const VSync &) {#namespace_h_p_1_1_omnicept_1_1_abi_1a0108acae2eb90e9a6c3b2a288a05e3bf}



class HP::Omnicept::Abi::BackpackColorZone {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_color_zone}

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public uint32_t r | public uint32_t g | public uint32_t b | public BackpackColorZone() = default | public BackpackColorZone(uint32_t r,uint32_t g,uint32_t b) | public virtual ~BackpackColorZone() = default | public bool operator==(const BackpackColorZone & other) const |


Members

public uint32_t r {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_color_zone_1a686a98a471398cccec235fd8ea5289ad}

public uint32_t g {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_color_zone_1a6deaa10c7dc71de3453d5e38cf1e6537}

public uint32_t b {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_color_zone_1adf52b0c9e0eaa3bf49620b785568aa50}

public BackpackColorZone() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_color_zone_1a61474c0985d4af3079069bbcec11d6ff}

public BackpackColorZone(uint32_t r,uint32_t g,uint32_t b) {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_color_zone_1a63a516f33488e1e3fa586f74846fcb64}

public virtual ~BackpackColorZone() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_color_zone_1a38639c781427d84b6ed2a267fd5a182e}

public bool operator==(const BackpackColorZone & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_color_zone_1a06ea14292b742f4ebaf1da88e47b1c6a}



class HP::Omnicept::Abi::BackpackColors {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_colors}

class HP::Omnicept::Abi::BackpackColors
  : public HP::Omnicept::Abi::GenericMessage

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public BackpackColors() | public BackpackColors(const std::vector< BackpackColorZone > & zones) | public virtual ~BackpackColors() = default | public std::vector< BackpackColorZone> &getColorZones() | public const std::vector< BackpackColorZone> &getColorZones() const | public bool operator==(const BackpackColors & other) const |


Members

public BackpackColors() {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_colors_1a4b3885b7061288ac2060d0c347340b90}

public BackpackColors(const std::vector< BackpackColorZone > & zones) {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_colors_1af4d6c392c4b1f4f34087760fa0ea1440}

public virtual ~BackpackColors() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_colors_1aadd296ad6bed69e15e0f0ec575dc3f01}

public std::vector< BackpackColorZone> &getColorZones() {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_colors_1a2e5e46a378877da813f0522f029d5236}

public const std::vector< BackpackColorZone> &getColorZones() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_colors_1a16c789f059d13d11a0f4c3cc478a0a10}

public bool operator==(const BackpackColors & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_backpack_colors_1a03e285ed09b5f051dc54644bfb00981f}



class HP::Omnicept::Abi::Battery {#class_h_p_1_1_omnicept_1_1_abi_1_1_battery}

class HP::Omnicept::Abi::Battery
  : public HP::Omnicept::Abi::GenericMessage

Domain type for battery data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public unsigned int id | public bool isPresent | public float percent | public Battery() | public virtual ~Battery() | public bool operator==(const Battery & other) const | public std::string toString() const |


Members

public unsigned int id {#class_h_p_1_1_omnicept_1_1_abi_1_1_battery_1acd65fae93498538820bb1a0a312f7de3}

public bool isPresent {#class_h_p_1_1_omnicept_1_1_abi_1_1_battery_1ad78a275bb53c43edc917a6b8b2672003}

public float percent {#class_h_p_1_1_omnicept_1_1_abi_1_1_battery_1a9f99a92561f68666d2b9e67927dde55b}

public Battery() {#class_h_p_1_1_omnicept_1_1_abi_1_1_battery_1a3253b947d868caf6c7a0343f6bc49de9}

public virtual ~Battery() {#class_h_p_1_1_omnicept_1_1_abi_1_1_battery_1a47c3eaa6d3882561531e895d55d39ed9}

public bool operator==(const Battery & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_battery_1ad8ed5d84ba29497f3f456c0e1d619f9e}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_battery_1adbfa98b57a63600fc0ece1fee512f602}



class HP::Omnicept::Abi::ByteMessage {#class_h_p_1_1_omnicept_1_1_abi_1_1_byte_message}

class HP::Omnicept::Abi::ByteMessage
  : public HP::Omnicept::Abi::GenericMessage

Domain type for byte message data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public std::string id | Identifier for the type of message. public std::string message | Body of the message as a string of bytes. public ByteMessage() | public ByteMessage(std::string id,std::string msg) | public virtual ~ByteMessage() | public bool operator==(const ByteMessage & other) const |


Members

public std::string id {#class_h_p_1_1_omnicept_1_1_abi_1_1_byte_message_1afc985559ed9f588a1e80e569e2d4ef06}

Identifier for the type of message.

public std::string message {#class_h_p_1_1_omnicept_1_1_abi_1_1_byte_message_1af87ea48b0b453861c0101159a351a8ac}

Body of the message as a string of bytes.

public ByteMessage() {#class_h_p_1_1_omnicept_1_1_abi_1_1_byte_message_1afb706e7c937a12f2b78219859f398213}

public ByteMessage(std::string id,std::string msg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_byte_message_1a71b19c9f86a9bb5dd4a227763836db2c}

public virtual ~ByteMessage() {#class_h_p_1_1_omnicept_1_1_abi_1_1_byte_message_1a8036cd2fb964aa6bfff6e550abeb62b8}

public bool operator==(const ByteMessage & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_byte_message_1afb670fa147332741d6f8f206ccdf1f12}



class HP::Omnicept::Abi::CameraImage {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image}

class HP::Omnicept::Abi::CameraImage
  : public HP::Omnicept::Abi::DomainData

Domain type for Camera Image data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public std::vector< unsigned char > imageData | Container of bytes that contains image data in format. public ImageFormat format | The specific arrangement of bytes for the data in imageData e.g. YUY2. public uint32_t width | Width of image in number of pixels. public uint32_t height | Height of image in number of pixels. public uint64_t frameNumber | Sequential image number for the frame. public float framesPerSecond | Number of frames camera captures per second. public CameraImage() | public virtual ~CameraImage() = default | public bool operator==(const CameraImage & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const | enum ImageFormat |


Members

public std::vector< unsigned char > imageData {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1ac63724aefc7a83c0c4c8a36c85224bb9}

Container of bytes that contains image data in format.

public ImageFormat format {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1af3bf32772daa682dab11b0d62bb3a6af}

The specific arrangement of bytes for the data in imageData e.g. YUY2.

public uint32_t width {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1a7585bf00fa6442ab19ddfd17abb6d160}

Width of image in number of pixels.

public uint32_t height {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1a6a47ca9f4b8dd364d0c3208034ccb7cc}

Height of image in number of pixels.

public uint64_t frameNumber {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1ab1bbfae82fdff8ca13dd7a819be1e942}

Sequential image number for the frame.

public float framesPerSecond {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1a6f439c279f1b9e9fc320f6278186d522}

Number of frames camera captures per second.

public CameraImage() {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1af059b33c4eb9e64d8c68e8b9bb98b803}

public virtual ~CameraImage() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1ad218ee5e4838cdfef4f4266d83f00554}

public bool operator==(const CameraImage & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1a22853d696e0e1b16d3682d5e832492fb}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1a9ba911cc36a61f669bda6a047a13ee89}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1a04a72732c6c41947085396599e72f866}

enum ImageFormat {#class_h_p_1_1_omnicept_1_1_abi_1_1_camera_image_1a5bad2d29608c00ed53400e375f277cc7}

Values | Descriptions
--------------------------------|--------------------------------------------- UNKNOWN | RGB888 | YUY2 | UYVY | YVYU | YUYV | AYUV | YV12 | NV12 | L8 | CUSTOM |



class HP::Omnicept::Abi::CognitiveLoad {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load}

class HP::Omnicept::Abi::CognitiveLoad
  : public HP::Omnicept::Abi::DomainData

Domain type for Cognitive Load prediction.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public float cognitiveLoad | Continuous estimate of cognitive load in range [0.f, 1.f] where 0.f is lowest cognitive load, and 1.f is the highest cognitive load. public float standardDeviation | A prediction error considering cognitive load as the center of a normal distribution. public CognitiveLoad() | public virtual ~CognitiveLoad() = default | public bool operator==(const CognitiveLoad & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const |


Members

public float cognitiveLoad {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_1aaba79f636f0763b2424247e91ff9923f}

Continuous estimate of cognitive load in range [0.f, 1.f] where 0.f is lowest cognitive load, and 1.f is the highest cognitive load.

public float standardDeviation {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_1a027171d02ccbc9fc72b5d0b41103e380}

A prediction error considering cognitive load as the center of a normal distribution.

public CognitiveLoad() {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_1a265e9c9f93485c4fb22e1b51ce38d158}

public virtual ~CognitiveLoad() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_1ae795196dbe7296533da472947b3c76e5}

public bool operator==(const CognitiveLoad & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_1aa63fc13f63e754ecaebfbadc9555bb98}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_1ab84e171c02c8e2f259e612cb234b3ef1}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_1a7ec5aedd9e21efebfff84924b1df3789}



class HP::Omnicept::Abi::NDimArrayFloat {#class_h_p_1_1_omnicept_1_1_abi_1_1_n_dim_array_float}

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public std::vector< uint32_t > shape | public std::vector< float > valuesFlat | public NDimArrayFloat() = default | public virtual ~NDimArrayFloat() = default | public bool operator==(const NDimArrayFloat & other) const | public std::string toString() const |


Members

public std::vector< uint32_t > shape {#class_h_p_1_1_omnicept_1_1_abi_1_1_n_dim_array_float_1a59887a893ce782fbe9820266c7c5850c}

public std::vector< float > valuesFlat {#class_h_p_1_1_omnicept_1_1_abi_1_1_n_dim_array_float_1a88a7ca0589449e416f7e9c8b8cd8d5d8}

public NDimArrayFloat() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_n_dim_array_float_1a5277e6e82c5501c8d1644686a169a801}

public virtual ~NDimArrayFloat() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_n_dim_array_float_1a6cc8d1ac27b790dd5ff3ad6ae2211e7e}

public bool operator==(const NDimArrayFloat & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_n_dim_array_float_1a5422d8bf93abdf0927ad491f91b24444}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_n_dim_array_float_1a544fb81baad56ce1e9ec5b104f055511}



class HP::Omnicept::Abi::CognitiveLoadInputFeature {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature}

class HP::Omnicept::Abi::CognitiveLoadInputFeature
  : public HP::Omnicept::Abi::DomainData

Domain type for Cognitive Load Input Feature data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public std::string dataState | public Timestamp startDataCollectTime | public Timestamp endDataCollectTime | public NDimArrayFloat features | public CognitiveLoadTargetModel targetModel | public CognitiveLoadInputFeature() | public virtual ~CognitiveLoadInputFeature() = default | public bool operator==(const CognitiveLoadInputFeature & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const |


Members

public std::string dataState {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature_1ab32ec68d50cb5f08c2f94712b565d511}

public Timestamp startDataCollectTime {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature_1a7accb79a1e888c270b38882feda57907}

public Timestamp endDataCollectTime {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature_1af8f9096656bb6b188c7f003e57a1a663}

public NDimArrayFloat features {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature_1acfaa75e7042fb54caa792d098a36c183}

public CognitiveLoadTargetModel targetModel {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature_1a72716d76ef98556a596ac984f6355d1f}

public CognitiveLoadInputFeature() {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature_1aa40a23ab9532a69482acba4288dc9abf}

public virtual ~CognitiveLoadInputFeature() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature_1a53d0bc0da153ff817dc26a44849378ee}

public bool operator==(const CognitiveLoadInputFeature & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature_1ac97fd6d77e4815193f143d8e3dd25859}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature_1acbc7fd36755aeb90ceb2b56d764e783f}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_cognitive_load_input_feature_1ad31f0afb69ca6ea4623e1a4ab09d2882}



class HP::Omnicept::Abi::ConfigurationError {#class_h_p_1_1_omnicept_1_1_abi_1_1_configuration_error}

class HP::Omnicept::Abi::ConfigurationError
  : public std::logic_error

Used for problems with accessing or performing operations on configuration files and values.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public ConfigurationErrorCode_t m_errorCode | public explicit ConfigurationError(const std::string & what_arg,const ConfigurationErrorCode_t errorCode) | public explicit ConfigurationError(const char * what_arg,const ConfigurationErrorCode_t errorCode) | public virtual ~ConfigurationError() = default |


Members

public ConfigurationErrorCode_t m_errorCode {#class_h_p_1_1_omnicept_1_1_abi_1_1_configuration_error_1a250ea9bc3e2143de85d523c65e1581ba}

public explicit ConfigurationError(const std::string & what_arg,const ConfigurationErrorCode_t errorCode) {#class_h_p_1_1_omnicept_1_1_abi_1_1_configuration_error_1a9a2e836ec7985c2218aa1561744b1c4a}

public explicit ConfigurationError(const char * what_arg,const ConfigurationErrorCode_t errorCode) {#class_h_p_1_1_omnicept_1_1_abi_1_1_configuration_error_1aaaa9fa44c194da549aa502153db883bd}

public virtual ~ConfigurationError() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_configuration_error_1a42a5e46c5cc5cd13b34234b13d530310}



class HP::Omnicept::Abi::ConnectionError {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_error}

class HP::Omnicept::Abi::ConnectionError
  : public std::logic_error

Used for problems in connection, meaning that the underlying connection mechanism failed.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public explicit ConnectionError(const std::string & what_arg) | public explicit ConnectionError(const char * what_arg) | public virtual ~ConnectionError() = default |


Members

public explicit ConnectionError(const std::string & what_arg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_error_1ae581b241b6fbec830e1d8dab0693174f}

public explicit ConnectionError(const char * what_arg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_error_1a5a0fbe0eb7f08cfacc4facd283d99ed2}

public virtual ~ConnectionError() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_error_1a6336fb2abae519e2fad600bcebfb3ae8}



class HP::Omnicept::Abi::ConnectionIdentifier {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier}

A unique identifier for each connection in HP Omnicept.

Made up of a human-readable connection name, assigned by an incoming connection, a delimiter, and a uuid assigned by the HP Omnicept Runtime

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public ConnectionIdentifier(const std::string connectionName,const std::string uuid) | Constructs a ConnectionIdentifier. public ConnectionIdentifier(const std::string identifier) | Constructs a ConnectionIdentifier. public ConnectionIdentifier(const std::string connectionName,const HP::Omnicept::Utils::IUuid & uuid) | Constructs a ConnectionIdentifier. public std::string getConnectionName() const | Gets the ConnectionIdentifier's connection name. public std::string getUuid() const | Gets the ConnectionIdentifier's uuid as a string. public ConnectionIdentifier() = delete | public ConnectionIdentifier(const ConnectionIdentifier &) = default | public ConnectionIdentifier(ConnectionIdentifier &&) = default | public ConnectionIdentifier&operator=(const ConnectionIdentifier &) = default | public ConnectionIdentifier&operator=(ConnectionIdentifier &&) = default | public operator std::string() const | public bool operator==(const ConnectionIdentifier & other) const | public bool operator!=(const ConnectionIdentifier & other) const | public bool operator<(const ConnectionIdentifier & other) const | public bool operator>(const ConnectionIdentifier & other) const | public bool operator<=(const ConnectionIdentifier & other) const | public bool operator>=(const ConnectionIdentifier & other) const |


Members

public ConnectionIdentifier(const std::string connectionName,const std::string uuid) {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a26ce9f2ec5f34c8d86d4cd5b2ec46282}

Constructs a ConnectionIdentifier.

Parameters

  • connectionName the human readable name given by the incoming connection

  • uuid the uuid assigned by the HP Omnicept Runtime as a string

Exceptions

  • std::invalid_argument if the connectionName is empty or if the uuid is invalid

public ConnectionIdentifier(const std::string identifier) {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1aaa11c0a4955ddeea074f442c9eb7c526}

Constructs a ConnectionIdentifier.

Parameters

Exceptions

  • std::invalid_argument the delimiter is missing, if the connectionName is empty, or if the uuid is invalid

public ConnectionIdentifier(const std::string connectionName,const HP::Omnicept::Utils::IUuid & uuid) {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a4c4baa40e557ea9cd73eeadca3df95b9}

Constructs a ConnectionIdentifier.

Parameters

  • connectionName the human readable name given by the incoming connection

  • uuid the uuid assigned by the HP Omnicept Runtime

Exceptions

  • std::invalid_argument if the connectionName is empty, or if the uuid is invalid

public std::string getConnectionName() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a0ad5bae87c14445edda7e21de9c75482}

Gets the ConnectionIdentifier's connection name.

Returns

the ConnectionIdentifier's connection name

public std::string getUuid() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a1517c0d12b6dc5241779b7d38b5966d4}

Gets the ConnectionIdentifier's uuid as a string.

Returns

the ConnectionIdentifier's uuid as a string

public ConnectionIdentifier() = delete {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1aa8b7d5bc96624638b49e7230770a0172}

public ConnectionIdentifier(const ConnectionIdentifier &) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1ab4a0defe6b979d2a299d292ea629b3fd}

public ConnectionIdentifier(ConnectionIdentifier &&) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a043070505784276675d1715b18cd429d}

public ConnectionIdentifier&operator=(const ConnectionIdentifier &) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a61571bc54b64142939106dc997bcd8bc}

public ConnectionIdentifier&operator=(ConnectionIdentifier &&) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1aab119c8ae1bfe9d7494756128e784a76}

public operator std::string() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a5f29ec88ea4aa9f3664d79221e6ceebc}

public bool operator==(const ConnectionIdentifier & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1ab38f0b7a859f9de1417fce11e3af0770}

public bool operator!=(const ConnectionIdentifier & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a3aaa3b793a9198bbb90c39f32902363a}

public bool operator<(const ConnectionIdentifier & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a082d908416b6bb04a108760263370af7}

public bool operator>(const ConnectionIdentifier & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a6b868b7b9c7d867cbb4bf312b73a0624}

public bool operator<=(const ConnectionIdentifier & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a5cbd8a20426aebb60d1fa1994a9c39d6}

public bool operator>=(const ConnectionIdentifier & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_connection_identifier_1a92f2b1df087caf5bc35ea9eb75bdafd8}



class HP::Omnicept::Abi::DataFrame {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_frame}

class HP::Omnicept::Abi::DataFrame
  : public HP::Omnicept::Abi::DomainData

Base class for framed DomainData. Includes a templated collection for the framed type. Framed data is a sequence of values that are collected over a period of time and processed as a unit, usually for efficiency purposes. A DataFrame contains one or more T data and a timestamp that represents the latest data.

Parameters

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public std::vector< T > data | public DataFrame(MessageType value) | public virtual ~DataFrame() = default | public std::string toString() const | public template<>
inline bool operator==(const DataFrame< T > & other) const | public inline virtual bool dataEquals(const DomainData & other) const | public inline bool dataEquals(const DataFrame< T > & other) const |


Members

public std::vector< T > data {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_frame_1ad56bb146028ec8f22649180fd73484a3}

public DataFrame(MessageType value) {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_frame_1a8cd87e5d60ca0fc7f30b458b2ae278e8}

public virtual ~DataFrame() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_frame_1ab74db28c8955ec2d5d7ca71613f8ac5d}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_frame_1a337bc2c89b7f632d026f049164375ed8}

public template<>
inline bool operator==(const DataFrame< T > & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_frame_1a2fc417600d9ea1d3db0056618854d1c2}

public inline virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_frame_1a1b46d21012d31e1a95e73343a5908348}

public inline bool dataEquals(const DataFrame< T > & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_frame_1a7502bfeb4d4fc22d193dba451cf250a4}



class HP::Omnicept::Abi::DataVaultResult {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_vault_result}

class HP::Omnicept::Abi::DataVaultResult
  : public HP::Omnicept::Abi::GenericMessage

A composite message to indicate DataVault recording result from a request to start or stop a DataVault recording.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public DataVaultResultType m_result | Result of a request to start or stop a Datavault recording. If DataVaultResultType::RECORDING_STARTED then a recording successfully started. If DataVaultResultType::RECORDING_STOPPED then a recording successfully stopped. All other values indicate errors, a more specific error is stored in m_error. public DataVaultResultErrorType m_error | Error from a DataVault request. There is no error if the value is DataVaultResultErrorType::SUCCESS_NO_ERROR. public std::string m_sessionId | The sessionId for a successfully started DataVault recording. Only set if m_result is DataVaultResultType::RECORDING_STARTED. public DataVaultResult() | public DataVaultResult(DataVaultResultType result,DataVaultResultErrorType error,std::string sessionId) | public std::string toString() const | public bool operator==(const DataVaultResult & rhs) const |


Members

public DataVaultResultType m_result {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_vault_result_1a5db47cf6c64fc581ef2393c33b9aa66e}

Result of a request to start or stop a Datavault recording. If DataVaultResultType::RECORDING_STARTED then a recording successfully started. If DataVaultResultType::RECORDING_STOPPED then a recording successfully stopped. All other values indicate errors, a more specific error is stored in m_error.

public DataVaultResultErrorType m_error {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_vault_result_1a1cccdb8af54b69fb926c1757822f7775}

Error from a DataVault request. There is no error if the value is DataVaultResultErrorType::SUCCESS_NO_ERROR.

public std::string m_sessionId {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_vault_result_1ae8400f418961e2119e2490759878d87f}

The sessionId for a successfully started DataVault recording. Only set if m_result is DataVaultResultType::RECORDING_STARTED.

public DataVaultResult() {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_vault_result_1a39c3798641566265c8eaf0c869833288}

public DataVaultResult(DataVaultResultType result,DataVaultResultErrorType error,std::string sessionId) {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_vault_result_1ac56a2e4fc100dacd805ec229daf0eda4}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_vault_result_1a873750adc96af93717855d586d2daac1}

public bool operator==(const DataVaultResult & rhs) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_data_vault_result_1a24ed52a8b97e428b139d82095c538c18}



class HP::Omnicept::Abi::Dependency {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency}

Domain type for a Dependency.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public Dependency() = default | Create Dependency. public explicit Dependency(std::map< std::string, std::string > initial) | Create Dependency from map. public explicit Dependency(const std::string & initial) | Create Dependency from string. public virtual ~Dependency() = default | Default destructor for Dependency. public bool has(const std::string & key) const | Checks if attribute exist. public std::vector< std::string > attributes() const | Return all attributes. public const std::string & get(const std::string & key) const | Retrieve attribute. public std::size_t size() const noexcept | Retrieve number of attributes. public void add(const std::string & key,const std::string & value) | Adds specified attribute. public void remove(const std::string & key) | Removes specified attribute. public bool operator==(const Dependency & other) const | public bool operator!=(const Dependency & other) const |


Members

public Dependency() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1a9f4999dc2f0e9407baad56739f06d767}

Create Dependency.

public explicit Dependency(std::map< std::string, std::string > initial) {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1a8f7d66dfe809b894baa14debbd973164}

Create Dependency from map.

Parameters

  • initial a map

public explicit Dependency(const std::string & initial) {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1ad2eb21c52d8821a087d720cf35ec057e}

Create Dependency from string.

Parameters

  • initial a string containing JSON object

Sample string: R"json({"device":"dummy","vid":"cafe","pid":"babe"})json"

public virtual ~Dependency() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1a4c85b7c0e31dd419699db050675a8fa4}

Default destructor for Dependency.

public bool has(const std::string & key) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1abb74ca1434d06c433c2d37d4e85b85f3}

Checks if attribute exist.

Parameters

  • key name of the attribute

Returns

true if exist, else false

public std::vector< std::string > attributes() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1a786c1da0c34d748114fbc55bdeae0df9}

Return all attributes.

Returns

attributes in this instance

public const std::string & get(const std::string & key) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1a48d41783a7b23132a792c09cfdfaff9d}

Retrieve attribute.

Parameters

  • key name of the attribute

Returns

value of attribute

Exceptions

  • std::out_of_range if attribute does not exist

public std::size_t size() const noexcept {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1a729c54ca73bbeb2e800329db3ac21711}

Retrieve number of attributes.

Returns

number of attributes

public void add(const std::string & key,const std::string & value) {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1aab2f9d2993e631e7af67f173315cd99e}

Adds specified attribute.

Parameters

  • key name of the attribute

  • value value of the attribute

public void remove(const std::string & key) {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1aa9a59ddebfee288cb129f4e9c8446248}

Removes specified attribute.

Parameters

  • key name of the attribute

public bool operator==(const Dependency & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1a382238cf858ac2024869aef60f80289e}

public bool operator!=(const Dependency & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_1a154bfba3816b1fb20e002bcb87d25c11}



class HP::Omnicept::Abi::DependencyList {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_list}

Domain type for a DependencyList.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public DependencyList() = default | public explicit DependencyList(std::vector< Dependency >) | public virtual ~DependencyList() = default | public bool has(const Dependency & dependency) const | Checks if dependency exist. public std::size_t size() const noexcept | Retrieve number of attributes. public void add(const Dependency & dependency) | Adds specified dependency. public void remove(const Dependency & dependency) | Removes specified dependency. public bool operator==(const DependencyList & other) const | public bool operator!=(const DependencyList & other) const |


Members

public DependencyList() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_list_1ae9e101c37b11de245e3d005e6ba975f6}

public explicit DependencyList(std::vector< Dependency >) {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_list_1ad69be2bdf84c1d6c6d6bac5aadb53790}

public virtual ~DependencyList() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_list_1aed0d1e71c6009770465ce23f5fd08bed}

public bool has(const Dependency & dependency) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_list_1aacdda024be9914ab3f1684fc80431207}

Checks if dependency exist.

Parameters

  • dependency dependency to check

Returns

true if exist, else false

public std::size_t size() const noexcept {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_list_1a07ff824a4089ff04290ac34a78c0c31c}

Retrieve number of attributes.

Returns

number of attributes

public void add(const Dependency & dependency) {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_list_1a5b3e8b27962ca6511901af229fb1643a}

Adds specified dependency.

Parameters

  • dependency the dependency to add

public void remove(const Dependency & dependency) {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_list_1ace2fb1fa8af9563362c70784184e28da}

Removes specified dependency.

Parameters

  • dependency the dependency to remove

public bool operator==(const DependencyList & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_list_1a385fbc2d42033d964bf0136b78eb1762}

public bool operator!=(const DependencyList & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_dependency_list_1af57ece586345a78c66e834da6666972c}



class HP::Omnicept::Abi::DomainData {#class_h_p_1_1_omnicept_1_1_abi_1_1_domain_data}

class HP::Omnicept::Abi::DomainData
  : public HP::Omnicept::Abi::GenericMessage

Base class for filterable timestamped domain type data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public SensorInfo sensorInfo | public Timestamp timestamp | public DomainData() = delete | public virtual ~DomainData() = default | public std::string toString() const | public bool operator==(const DomainData & other) const | public bool dataEquals(const DomainData & other) const |


Members

public SensorInfo sensorInfo {#class_h_p_1_1_omnicept_1_1_abi_1_1_domain_data_1ab1266643cbd4ffb4c72e8e1c873b9710}

public Timestamp timestamp {#class_h_p_1_1_omnicept_1_1_abi_1_1_domain_data_1abee7efc27c97eedfc459d3151cdb1b86}

public DomainData() = delete {#class_h_p_1_1_omnicept_1_1_abi_1_1_domain_data_1ac27f322198b94e6ab1b8ba249fd83418}

public virtual ~DomainData() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_domain_data_1a28098780e8d197d3ef6dc136b3c1b3ac}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_domain_data_1ae6e288195e6ec06a4a161c037ac91ca6}

public bool operator==(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_domain_data_1a37ac5344eea936106074387b9abd2572}

public bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_domain_data_1a4e966aab972cb435747c040474f02c53}



class HP::Omnicept::Abi::EyePupilDiameter {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupil_diameter}

Domain type for eye pupil data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public float size | Approximate pupil diameter in millimeters. public float confidence | Confidence in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid. public EyePupilDiameter() | public EyePupilDiameter(float size,float confidence) | public virtual ~EyePupilDiameter() = default | public bool operator==(const EyePupilDiameter & other) const | public std::string toString() const |


Members

public float size {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupil_diameter_1a62daf9e4db9e04ab2d6f22231b3afc1e}

Approximate pupil diameter in millimeters.

public float confidence {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupil_diameter_1a63ab8126bbc8aae7b1d41da4f172f698}

Confidence in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.

public EyePupilDiameter() {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupil_diameter_1aa26149a67052c19ed7f8143cac37c591}

public EyePupilDiameter(float size,float confidence) {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupil_diameter_1a9a1ec30254ce88ea42562f60f3aabd92}

public virtual ~EyePupilDiameter() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupil_diameter_1a8c9633c0ffc725e155befb084e3a01e1}

public bool operator==(const EyePupilDiameter & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupil_diameter_1a0424c508e7aca645b567aa0342e76a89}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupil_diameter_1a8565f5b6e3b768a68d734a8208c493d2}



class HP::Omnicept::Abi::EyePupillometry {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry}

class HP::Omnicept::Abi::EyePupillometry
  : public HP::Omnicept::Abi::DomainData

Domain type for both eye's eye pupil data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public EyePupilDiameter rightPupilDiameter | EyePupilDiameter for right eye. public EyePupilDiameter leftPupilDiameter | EyePupilDiameter for left eye. public EyePupillometry() | public EyePupillometry(EyePupilDiameter left,EyePupilDiameter right) | public virtual ~EyePupillometry() = default | public bool operator==(const EyePupillometry & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const |


Members

public EyePupilDiameter rightPupilDiameter {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_1aed3e6be789b2716a6c1733311f305d37}

EyePupilDiameter for right eye.

public EyePupilDiameter leftPupilDiameter {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_1aa13233a1368e8f68bb146ba1d515c03d}

EyePupilDiameter for left eye.

public EyePupillometry() {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_1a4b5f3dc3aa5f970206c95aace23ae570}

public EyePupillometry(EyePupilDiameter left,EyePupilDiameter right) {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_1a71e15f85a62a6dffdff0a0289d0acb8d}

public virtual ~EyePupillometry() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_1a914497270e960fdc6b607565eab53aac}

public bool operator==(const EyePupillometry & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_1acae9bc2d511b414ef74202be071ba65b}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_1a46118dd04f5df9fc1e69c28002a2d910}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_1a8bfa0419257a3970825b70ca30349718}



class HP::Omnicept::Abi::EyePupillometryFrame {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_frame}

class HP::Omnicept::Abi::EyePupillometryFrame
  : public HP::Omnicept::Abi::DataFrame< EyePupillometry >

Domain type for EyePupillometry frame data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public EyePupillometryFrame() | public virtual ~EyePupillometryFrame() = default |


Members

public EyePupillometryFrame() {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_frame_1a801d86bd319b96659b03a2b6de9d707a}

public virtual ~EyePupillometryFrame() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_pupillometry_frame_1a03a40e3cf3f5d1043da804785b504a3a}



class HP::Omnicept::Abi::EyeTracking {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking}

class HP::Omnicept::Abi::EyeTracking
  : public HP::Omnicept::Abi::DomainData

Domain type for eye tracking data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public EyeGaze leftGaze | EyeGaze for left eye. public float leftGazeConfidence | Confidence for leftGaze in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid. public EyeGaze rightGaze | EyeGaze for right eye. public float rightGazeConfidence | Confidence for rightGaze in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid. public EyeGaze combinedGaze | Combined EyeGaze. public float combinedGazeConfidence | Confidence combinedGaze in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid. public float leftPupilDilation | Left eye pupil dilation in millimeters. public float leftPupilDilationConfidence | Confidence for leftPupilDilation in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid. public float rightPupilDilation | Right eye pupil dilation in millimeters. public float rightPupilDilationConfidence | Confidence for rightPupilDilation in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid. public PupilPosition leftPupilPosition | PupilPosition of left pupil. public float leftPupilPositionConfidence | Confidence for leftPupilPositionConfidence in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid. public PupilPosition rightPupilPosition | PupilPosition of right pupil. public float rightPupilPositionConfidence | Confidence for rightPupilPositionConfidence in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid. public float leftEyeOpenness | Left eye openness 0.f = closed 1.f = open. public float leftEyeOpennessConfidence | Confidence for leftEyeOpenness in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid. public float rightEyeOpenness | Right eye openness 0.f = closed 1.f = open. public float rightEyeOpennessConfidence | Confidence for rightEyeOpenness in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid. public EyeTracking() | public virtual ~EyeTracking() = default | public bool operator==(const EyeTracking & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const |


Members

public EyeGaze leftGaze {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1aa59ccdd5eb42ae808e12351d2f9f876e}

EyeGaze for left eye.

public float leftGazeConfidence {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1abee6c8bc681a51dcae0e4a0ec914931d}

Confidence for leftGaze in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.

public EyeGaze rightGaze {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a34dc589e1be341eb852ad7b1c46c6fe7}

EyeGaze for right eye.

public float rightGazeConfidence {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1ace991f5b2a4ea8701850ca309be2c6aa}

Confidence for rightGaze in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.

public EyeGaze combinedGaze {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a4383f20c06ca4327d11a37ce196ff642}

Combined EyeGaze.

public float combinedGazeConfidence {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a930e0c9555c65c6a08dda2873d78eecf}

Confidence combinedGaze in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.

public float leftPupilDilation {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a459596e176e6666156c6efbb66e01917}

Left eye pupil dilation in millimeters.

public float leftPupilDilationConfidence {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1afd74609670061930e9c1579ab3d91672}

Confidence for leftPupilDilation in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.

public float rightPupilDilation {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1af42380208d04f35a61494e13617ac40b}

Right eye pupil dilation in millimeters.

public float rightPupilDilationConfidence {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1ac600c48fc7913682e2acf1f817ae1a24}

Confidence for rightPupilDilation in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.

public PupilPosition leftPupilPosition {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a7298cb643e83aa1588ecb99544fb445c}

PupilPosition of left pupil.

public float leftPupilPositionConfidence {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1aececb6b08d9c05ece4557215d146313d}

Confidence for leftPupilPositionConfidence in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.

public PupilPosition rightPupilPosition {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1aa2a5f2829892fce5f228278390842205}

PupilPosition of right pupil.

public float rightPupilPositionConfidence {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a863c5b664c0a527939fca32a9f08c549}

Confidence for rightPupilPositionConfidence in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.

public float leftEyeOpenness {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a07c4724f8853cf91feb366499c098b27}

Left eye openness 0.f = closed 1.f = open.

public float leftEyeOpennessConfidence {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1ad656216d5026c828e33423ad4fc48ef6}

Confidence for leftEyeOpenness in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.

public float rightEyeOpenness {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a89e9d2f57ab8ebe66600639a0a604752}

Right eye openness 0.f = closed 1.f = open.

public float rightEyeOpennessConfidence {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a8b877eb82a9e5457a15495e6683e2648}

Confidence for rightEyeOpenness in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.

public EyeTracking() {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a3724b07ac4301d1032906be4f2ad8599}

public virtual ~EyeTracking() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a40094535a8c3628c9d6ee18f40e9088f}

public bool operator==(const EyeTracking & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a0beb2b83c9b4fd615a4e7fceb656a22d}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1a89fd570526229226d5410438be9343f0}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_1ad71fd1f11f755f21e377833481c55b87}



class HP::Omnicept::Abi::EyeTrackingFrame {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_frame}

class HP::Omnicept::Abi::EyeTrackingFrame
  : public HP::Omnicept::Abi::DataFrame< EyeTracking >

Domain type for EyeTracking frame data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public EyeTrackingFrame() | public virtual ~EyeTrackingFrame() = default |


Members

public EyeTrackingFrame() {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_frame_1a028ae57cca6b349d800f3c9f869c596f}

public virtual ~EyeTrackingFrame() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_tracking_frame_1af8b6adfa0cf5bfe55da9b4bb3b90bc01}



class HP::Omnicept::Abi::GenericMessage {#class_h_p_1_1_omnicept_1_1_abi_1_1_generic_message}

Base class for all domain types.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public GenericMessage() = delete | public GenericMessage(MessageType msgType) | public virtual ~GenericMessage() = default | public MessageType getMessageType() const | public bool operator==(const GenericMessage & other) const |


Members

public GenericMessage() = delete {#class_h_p_1_1_omnicept_1_1_abi_1_1_generic_message_1a94bfcfbaa8e797045f191537b58f8235}

public GenericMessage(MessageType msgType) {#class_h_p_1_1_omnicept_1_1_abi_1_1_generic_message_1aadb3e45076867b4698e446551150c127}

public virtual ~GenericMessage() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_generic_message_1a7e4dd97fd2715e673728091bcf210c98}

public MessageType getMessageType() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_generic_message_1a94454d0449e9cfd5f021ad597900e5ea}

public bool operator==(const GenericMessage & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_generic_message_1a114af8e76ffd970f5ac3da6fa5ecc0db}



class HP::Omnicept::Abi::HandshakeError {#class_h_p_1_1_omnicept_1_1_abi_1_1_handshake_error}

class HP::Omnicept::Abi::HandshakeError
  : public std::exception

Used for failures during the the handshake that attempts to create a connection between a client and the HP Omnicept Runtime.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public explicit HandshakeError(const std::string & what_arg) | public explicit HandshakeError(const char * what_arg) | public const char * what() const | public virtual ~HandshakeError() = default |


Members

public explicit HandshakeError(const std::string & what_arg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_handshake_error_1a484a776c0be7d95365d57750c88061b5}

public explicit HandshakeError(const char * what_arg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_handshake_error_1a462c42a924743904312f4042700378ee}

public const char * what() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_handshake_error_1a1ceb0da0ebfa178f07419ef5a7a07bef}

public virtual ~HandshakeError() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_handshake_error_1aa2568b03f3a372d3793a547b8fc11a5c}



class HP::Omnicept::Abi::HeartRate {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate}

class HP::Omnicept::Abi::HeartRate
  : public HP::Omnicept::Abi::DomainData

Domain type for heart rate data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public uint32_t rate | Heart beats per minute. Zero value indicates sensor signal quality is too poor to calculate. public HeartRate() | public virtual ~HeartRate() | public bool operator==(const HeartRate & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const |


Members

public uint32_t rate {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_1a948a00df7e03054b800cd36e0db08c19}

Heart beats per minute. Zero value indicates sensor signal quality is too poor to calculate.

public HeartRate() {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_1a930f7811bc8080b8363cd9fd1fc5d7e7}

public virtual ~HeartRate() {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_1a9b423488a3406738230f4c1d2ab41623}

public bool operator==(const HeartRate & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_1a3da4ac2d61b32ce6522d26eebc14dcdb}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_1a3e01b96c9de02fa5992647972455327e}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_1ab7e84f3d036bc56c17e7c40c45f477ef}



class HP::Omnicept::Abi::HeartRateFrame {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_frame}

class HP::Omnicept::Abi::HeartRateFrame
  : public HP::Omnicept::Abi::DataFrame< HeartRate >

Domain type for HeartRate Frames.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public HeartRateFrame() | public virtual ~HeartRateFrame() = default |


Members

public HeartRateFrame() {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_frame_1a1302d9e8fd50463be3aacc344b0f9583}

public virtual ~HeartRateFrame() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_frame_1a1cb9c563e7622032defdcea917ee2adb}



class HP::Omnicept::Abi::HeartRateVariability {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_variability}

class HP::Omnicept::Abi::HeartRateVariability
  : public HP::Omnicept::Abi::DomainData

Domain type for heart rate variability data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public float sdnn | Standard deviation between two normal heart beats in milliseconds. Zero value indicates sensor signal quality is too poor to calculate. public float rmssd | Root-mean square of successive differences in milliseconds. Zero value indicates sensor signal quality is too poor to calculate. public HeartRateVariability() | public virtual ~HeartRateVariability() | public bool operator==(const HeartRateVariability & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const |


Members

public float sdnn {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_variability_1adc99c275031de843c202959af9a494cf}

Standard deviation between two normal heart beats in milliseconds. Zero value indicates sensor signal quality is too poor to calculate.

public float rmssd {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_variability_1a5797d7899eaf156f6b1b354ed33fe431}

Root-mean square of successive differences in milliseconds. Zero value indicates sensor signal quality is too poor to calculate.

public HeartRateVariability() {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_variability_1a5a905079f28a821fb7d2ee844cf920ba}

public virtual ~HeartRateVariability() {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_variability_1a180fab1d2c131593815f1adb28119d18}

public bool operator==(const HeartRateVariability & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_variability_1af1274871001b0779645e5e9065b98f82}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_variability_1a5114fb4444dc292f2261e5b3a773f8e3}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_heart_rate_variability_1a340c27ca13177a30934fd8afbb41e8a1}



class HP::Omnicept::Abi::IMessage {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message}

ABC for all messages, the intermediate step between domain types and serialized bytes.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public virtual ~IMessage() = default | public MessageType getMessageType() const | Gets the message type, indicating what the payload is. public void setSender(std::string) | Sets the sender, where the message originated from. public std::string getSender() const | Gets the sender, where the message originated from. public std::unique_ptr< ConnectionIdentifier>getSenderConnectionId() const | Gets the sender's connection id, if the sender field of the message is a ConnectionIdentifier, otherwise returns nullptr. public void setDestination(const std::string) | Sets the destination, where the message should be sent. If empty will send to all connections. public std::string getDestination() const | Gets the destination, where the message is to be sent to. public uint64_t getHeaderByteLength() const | Gets the length of the header, in bytes. public uint64_t getBodyByteLength() const | Gets the length of the body, in bytes. public const SensorInfo&getSensorInfo() const | Get the associate sensorInfo for this message. public uint64_t serializeHeaderToByteArray(uint8_t * destination,uint64_t maxLength) | Writes the header (PackageDeclaration) into a byte array. public uint64_t serializeBodyToByteArray(uint8_t * destination,uint64_t maxLength) | Writes the body into a byte array. public template<>
inline bool isMessageA() const | Checks if an IMessage is a serialized DomainType message.


Members

public virtual ~IMessage() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1a1d4ffc07989f7a68c8f3eeba458c2451}

public MessageType getMessageType() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1a82c94fef921593ab978a76efbce3eeac}

Gets the message type, indicating what the payload is.

public void setSender(std::string) {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1a79a35f23b860dff7b8bf7903ac809990}

Sets the sender, where the message originated from.

public std::string getSender() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1a36e28a6dda124c921f3294aee6629451}

Gets the sender, where the message originated from.

public std::unique_ptr< ConnectionIdentifier>getSenderConnectionId() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1a55eb784b4a9dd4bd6e26b1b5131dc844}

Gets the sender's connection id, if the sender field of the message is a ConnectionIdentifier, otherwise returns nullptr.

public void setDestination(const std::string) {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1a383486b6bc08496457f452999fdc0c41}

Sets the destination, where the message should be sent. If empty will send to all connections.

public std::string getDestination() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1aa6de804cdf14655e23c87a0fef12f113}

Gets the destination, where the message is to be sent to.

public uint64_t getHeaderByteLength() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1acdd2a95141a87e3112347da271d6ece9}

Gets the length of the header, in bytes.

public uint64_t getBodyByteLength() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1a5488b7299db863d1dd829de0d8cd33ca}

Gets the length of the body, in bytes.

public const SensorInfo&getSensorInfo() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1a3849b0c41be8d51894ddf343ea10728d}

Get the associate sensorInfo for this message.

public uint64_t serializeHeaderToByteArray(uint8_t * destination,uint64_t maxLength) {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1aca3e54e6ec407e946890455a8e3aaa54}

Writes the header (PackageDeclaration) into a byte array.

Parameters

  • destination The byte buffer to write into.

  • maxLength the maximum number of bytes the function is allowed to write. If the function needs more space, it will not write at all.

Returns

The number of bytes written into the destination

public uint64_t serializeBodyToByteArray(uint8_t * destination,uint64_t maxLength) {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1a4aa965f0e31a32a5aebe1c9bb4446576}

Writes the body into a byte array.

Parameters

  • destination The byte buffer to write into.

  • maxLength the maximum number of bytes the function is allowed to write. If the function needs more space, it will not write at all.

Returns

The number of bytes written into the destination

public template<>
inline bool isMessageA() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_message_1ade9e2de4c5d4ddd21992696997cc2d78}

Checks if an IMessage is a serialized DomainType message.

Use instead of hardcoding a MessageType into a check

Parameters

Returns

true if msg can be serialized to a DomainType, else false



class HP::Omnicept::Abi::IMU3AxisValues {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u3_axis_values}

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public float x | public float y | public float z | public IMU3AxisValues() | public IMU3AxisValues(float x,float y,float z) | public virtual ~IMU3AxisValues() = default | public bool operator==(const IMU3AxisValues & other) const | public std::string toString() const |


Members

public float x {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u3_axis_values_1a18d87523bcaa9e42daf646fdbc99821b}

public float y {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u3_axis_values_1ae9e25ce90dd856e859e022af41223d3e}

public float z {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u3_axis_values_1a3ebf0858210d66f48f2b03b9bad2c3ac}

public IMU3AxisValues() {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u3_axis_values_1a7bd734f1c0000a981a3667d48cff7f90}

public IMU3AxisValues(float x,float y,float z) {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u3_axis_values_1a5e3232c8e769e76a5ee021da4654c05d}

public virtual ~IMU3AxisValues() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u3_axis_values_1a6a44e17dafff650d47e7c9c65eab1efa}

public bool operator==(const IMU3AxisValues & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u3_axis_values_1a1394e6fcd49aef17ff6834af523f8728}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u3_axis_values_1ae3a701c1b8dd80d3b923b90a018b632a}



class HP::Omnicept::Abi::IMU {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u}

class HP::Omnicept::Abi::IMU
  : public HP::Omnicept::Abi::DomainData

Domain type for inertial measurement unit (IMU) data.

A single IMU contains six data sets, including x-y-z axis of accelerometer and x-y-z axis of gyroscope.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public IMU3AxisValues acc | Accelerometer IMU3AxisValues. public IMU3AxisValues gyro | Gyro IMU3AxisValues. public IMU() | public IMU(IMU3AxisValues accValues,IMU3AxisValues gyroValues) | public virtual ~IMU() = default | public bool operator==(const IMU & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const |


Members

public IMU3AxisValues acc {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_1a9ae82c7dc15f207fbd136fe90cee1113}

Accelerometer IMU3AxisValues.

+x is up, +y is left, +z is forward from user. Units are G's (9.8 m/s^2)

public IMU3AxisValues gyro {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_1a038c0515512b3ce9192da28f2a889ca4}

Gyro IMU3AxisValues.

x is yaw, y is pitch, z is roll. +x when the user turning their head to the right +y when the user looks downwards +z when the user tilts their head to the right

Units are degrees per second

public IMU() {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_1ab419f83cb656ee5a857b2136041916e2}

public IMU(IMU3AxisValues accValues,IMU3AxisValues gyroValues) {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_1a213bc23026abda8ca366de84707cec60}

public virtual ~IMU() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_1aae8e4220cb65bc97c1e4cc9fbd7e8908}

public bool operator==(const IMU & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_1ac1c90537715070df1866789edc882fd2}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_1a48748d2e6c1921735ce7a12c108e5ee4}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_1a68be648a313c3353e8860c0bfc53ab96}



class HP::Omnicept::Abi::IMUFrame {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_frame}

class HP::Omnicept::Abi::IMUFrame
  : public HP::Omnicept::Abi::DataFrame< IMU >

Domain type for IMU Frames.

The Frame contains one or more IMU data and a timestamp that represents the latest data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public IMUFrame() | public virtual ~IMUFrame() = default |


Members

public IMUFrame() {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_frame_1aea6e7dae136dfcda8a7c1818f27ec972}

public virtual ~IMUFrame() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_i_m_u_frame_1a390e6190df62193f5a754af7b0af14c4}



class HP::Omnicept::Abi::MessageTypeUtils {#class_h_p_1_1_omnicept_1_1_abi_1_1_message_type_utils}

Summary

Members | Descriptions
--------------------------------|---------------------------------------------


Members



class HP::Omnicept::Abi::ModuleControlSignal {#class_h_p_1_1_omnicept_1_1_abi_1_1_module_control_signal}

class HP::Omnicept::Abi::ModuleControlSignal
  : public HP::Omnicept::Abi::GenericMessage

Domain type for status signals between the HP Omnicept Runtime and its connections.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public ModuleControlSignal() | public ModuleControlSignal(ModuleControlSignalType signal) | public ~ModuleControlSignal() = default | public void SetSignal(ModuleControlSignalType signal) | public const ModuleControlSignalType GetSignal() const | public bool operator==(const ModuleControlSignal & other) const |


Members

public ModuleControlSignal() {#class_h_p_1_1_omnicept_1_1_abi_1_1_module_control_signal_1add32a44ec861a7c9dfba3fa7e6a73a0d}

public ModuleControlSignal(ModuleControlSignalType signal) {#class_h_p_1_1_omnicept_1_1_abi_1_1_module_control_signal_1a8cf914c0fdd1718ed87e46acb85435fd}

public ~ModuleControlSignal() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_module_control_signal_1a8fae904efda5b141cfdbac1a21716db2}

public void SetSignal(ModuleControlSignalType signal) {#class_h_p_1_1_omnicept_1_1_abi_1_1_module_control_signal_1aeef340e1d5af5a19cd0a1aa63d7cbd10}

public const ModuleControlSignalType GetSignal() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_module_control_signal_1a82d4e24b57b923f1e17b3c8f09be350f}

public bool operator==(const ModuleControlSignal & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_module_control_signal_1aa6f786e2989b8c329d3405fa10db4467}



class HP::Omnicept::Abi::PPG {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g}

class HP::Omnicept::Abi::PPG
  : public HP::Omnicept::Abi::DomainData

Domain type for photoplethysmography (PPG) data.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public std::vector< uint32_t > ledValues | PPG values public PPG() | public PPG(const std::vector< uint32_t > & values) | public virtual ~PPG() = default | public bool operator==(const PPG & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const |


Members

public std::vector< uint32_t > ledValues {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_1a10af907fdcaa4f48f61b48f66e452b97}

PPG values

Values will be set based on SensorInfo. Check the containing PPGFrame::sensorInfo to ensure that the data is in the format you expect.

For HP Reverb G2 Omnicept Edition:

  • PPGFrame::sensorInfo will have:

  • ID: "HP Reverb G2 Omnicept"

  • SubID: "MAX86140"

  • Location: "Forehead"

  • And the indices of the PPG values returned for that correspond to:

  • ledValues[0] PPG captured with only the first LED on.

  • ledValues[1] PPG captured with only the second LED on.

  • ledValues[2] PPG captured with just ambient light.

public PPG() {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_1afb42af77f07e3d1dc09b6aa135880689}

public PPG(const std::vector< uint32_t > & values) {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_1a6bd66ffecf63b69fa62cd0c2b91b7cdd}

public virtual ~PPG() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_1a2485395a076b4133ea06d70b1cc27858}

public bool operator==(const PPG & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_1ab133ff26c712ec6d7d5cbaa97be30934}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_1ad1c26acf95f37320edb929fa64471b8a}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_1a8232457b61242d71d7e3bd36bbc820ed}



class HP::Omnicept::Abi::PPGFrame {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_frame}

class HP::Omnicept::Abi::PPGFrame
  : public HP::Omnicept::Abi::DataFrame< PPG >

Domain type for PPG Frames.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public std::vector< uint32_t > ledCurrents | LED brightness values on [0-255] scale. public PPGFrame() | public PPGFrame(std::vector< uint32_t > & ledCurrents) | public virtual ~PPGFrame() = default | public std::string toString() const |


Members

public std::vector< uint32_t > ledCurrents {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_frame_1a0d82f737ae9a204bdde4c5e6189d42eb}

LED brightness values on [0-255] scale.

Values will be set based on SensorInfo. Check PPGFrame::sensorInfo to ensure that the data is in the format you expect.

For HP Reverb G2 Omnicept Edition:

  • PPGFrame::sensorInfo will have:

  • ID: "HP Reverb G2 Omnicept"

  • SubID: "MAX86140"

  • Location: "Forehead"

  • And the indices of the LED brightness returned for that sensor correspond to:

  • ledCurrents[0] brightness of the first LED,

  • ledCurrents[1] brightness of the second LED.

public PPGFrame() {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_frame_1a525ee3513dd483dff8ef0263c79c0c6e}

public PPGFrame(std::vector< uint32_t > & ledCurrents) {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_frame_1a65d1e00c871118107fa26e093c0a4702}

public virtual ~PPGFrame() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_frame_1a06a9d728a57ab8314e5806db500b0dbd}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_p_p_g_frame_1a97b3355209b08ab23ba5b10ec92d13ad}



class HP::Omnicept::Abi::ProtocolError {#class_h_p_1_1_omnicept_1_1_abi_1_1_protocol_error}

class HP::Omnicept::Abi::ProtocolError
  : public std::logic_error

Used for problems in protocol, meaning that the wrong kinds of messages are seen, or they are observed in the wrong order.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public explicit ProtocolError(const std::string & what_arg) | public explicit ProtocolError(const char * what_arg) | public virtual ~ProtocolError() = default |


Members

public explicit ProtocolError(const std::string & what_arg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_protocol_error_1aea5a2bfa352ea0708bf6ffcb41ae4251}

public explicit ProtocolError(const char * what_arg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_protocol_error_1a4b56a34fa9abf8566a365b1a89fbf928}

public virtual ~ProtocolError() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_protocol_error_1aee4d1901dafa6c4f2a09b5dfc0bfd68b}



class HP::Omnicept::Abi::EyeSceneColors {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_scene_colors}

Domain type for eye average color and brightness.

Contains the ambient and foveal average color a single Eye

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public Color ambientColor | Ambient color is average color calculated over the entire image. public Color fovealColor | Foveal color is average color calculated over the foveal region of the eye. public EyeSceneColors() | public EyeSceneColors(const Color& ambient,constColor & foveal) | public virtual ~EyeSceneColors() = default | public bool operator==(const EyeSceneColors & other) const | public std::string toString() const |


Members

public Color ambientColor {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_scene_colors_1a7d05cfb5169417bb7daa066e0fdb2473}

Ambient color is average color calculated over the entire image.

public Color fovealColor {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_scene_colors_1a54307c755c044c6c32bcf2b3e7f286ab}

Foveal color is average color calculated over the foveal region of the eye.

public EyeSceneColors() {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_scene_colors_1ad73787b85bc7aa4df48831c668824ea2}

public EyeSceneColors(const Color& ambient,constColor & foveal) {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_scene_colors_1ad0c91a9c8aae339854991a654f51b972}

public virtual ~EyeSceneColors() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_scene_colors_1a8342de51df668426b7fdeb9b08a85512}

public bool operator==(const EyeSceneColors & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_scene_colors_1a2f050f3236f96647352d0c9ecde403c0}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_eye_scene_colors_1a1da645c820670f83c2272af952d9dbb8}



class HP::Omnicept::Abi::SceneColor {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color}

class HP::Omnicept::Abi::SceneColor
  : public HP::Omnicept::Abi::DomainData

Domain type for HMD average color and brightness.

Contains the ambient and foveal average color and left and right eyes.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public EyeSceneColors leftEyeSceneColors | EyeSceneColors for left display. public EyeSceneColors rightEyeSceneColors | EyeSceneColors for right display. public SceneColor() | public SceneColor(const EyeSceneColors& left,constEyeSceneColors & right) | public virtual ~SceneColor() = default | public bool operator==(const SceneColor & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const |


Members

public EyeSceneColors leftEyeSceneColors {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_1ab723298aeb7e3b2ca99fc0b73da05ff2}

EyeSceneColors for left display.

public EyeSceneColors rightEyeSceneColors {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_1a14fe3d8667164d868a3fc0dead73d40f}

EyeSceneColors for right display.

public SceneColor() {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_1a50efc05b53ab611db132014082a4028a}

public SceneColor(const EyeSceneColors& left,constEyeSceneColors & right) {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_1a61992e0edc8fa7c1977c6538a02bef8b}

public virtual ~SceneColor() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_1a72231225d12169e7d1a516d54dd7b4fd}

public bool operator==(const SceneColor & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_1a3a72323065c5133d827c02ec27dd960f}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_1ac300c67b0ffa26033a89d57496bc867b}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_1a2c9645dbb8fc7834b2f025eb376c29aa}



class HP::Omnicept::Abi::SceneColorFrame {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_frame}

class HP::Omnicept::Abi::SceneColorFrame
  : public HP::Omnicept::Abi::DataFrame< SceneColor >

Domain type for Framed SceneColors.

Contains the ambient and foveal average color for the left and right eyes (Framed).

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public SceneColorFrame() | public virtual ~SceneColorFrame() = default |


Members

public SceneColorFrame() {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_frame_1a6da1a078091d4387320a0a6bf1c10cfa}

public virtual ~SceneColorFrame() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_scene_color_frame_1aebc9720ead0d2acbddee0248f6829629}



class HP::Omnicept::Abi::SensorDeviceId {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id}

Uniquely identifies a sensor.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public std::string id | An identifier for a sensor, for example, a sensor type or model number. public std::string subId | A further identifier, for example, to distinguish between multiple kinds of sensor hardware or multiple present sensors. public SensorDeviceId() = default | public SensorDeviceId(const SensorDeviceId &) = default | public SensorDeviceId(SensorDeviceId &&) = default | public SensorDeviceId&operator=(const SensorDeviceId &) = default | public SensorDeviceId&operator=(SensorDeviceId &&) = default | public SensorDeviceId(const std::string & id,const std::string & subId) | public virtual ~SensorDeviceId() = default | public bool operator==(const SensorDeviceId & other) const | public bool operator<(const SensorDeviceId & rhs) const |


Members

public std::string id {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1ac8d66af2bbc94a35184f288b4d18982f}

An identifier for a sensor, for example, a sensor type or model number.

public std::string subId {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1a029f1ddd9c07a9804dc2b5b3e0082527}

A further identifier, for example, to distinguish between multiple kinds of sensor hardware or multiple present sensors.

public SensorDeviceId() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1aaed0aabcd35dea2ccaccdcfa81a5ef4e}

public SensorDeviceId(const SensorDeviceId &) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1a6269d5b3c5deeac1e5aebf41c4126f57}

public SensorDeviceId(SensorDeviceId &&) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1afe29c912390ec4bbaa9657176851e2d0}

public SensorDeviceId&operator=(const SensorDeviceId &) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1a85b10b5e2252b54600c1766ef7019ec5}

public SensorDeviceId&operator=(SensorDeviceId &&) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1a88e5d08953a78a918a2d4076ea5e0313}

public SensorDeviceId(const std::string & id,const std::string & subId) {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1a88a24ad40434eb98d3b3533c62f4809b}

public virtual ~SensorDeviceId() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1a5902c723f70746695b92429412b7d78e}

public bool operator==(const SensorDeviceId & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1ac03d6257ed5ec962c871a7d90ae03e83}

public bool operator<(const SensorDeviceId & rhs) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_device_id_1a91bade9891dbf0926cb23fa055f58065}



class HP::Omnicept::Abi::SensorInfo {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info}

Uniquely identifies a sensor and provides filterable or configurable information about it.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public SensorDeviceId deviceId | the sensor's unique identifier public std::string location | The sensor's physical location, such as the body part where contact is made and measurements are taken. public SensorInfo() | public SensorInfo(const SensorDeviceId & deviceId,const std::string & location) | public SensorInfo(const SensorInfo &) = default | public SensorInfo(SensorInfo &&) = default | public SensorInfo&operator=(const SensorInfo &) = default | public SensorInfo&operator=(SensorInfo &&) = default | public SensorInfo(const std::string & id,const std::string & subid,const std::string & location) | public virtual ~SensorInfo() = default | public bool operator==(const SensorInfo & other) const | public bool operator<(const SensorInfo & rhs) const |


Members

public SensorDeviceId deviceId {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1a362cac9326b54da3f646e4fae0b4afac}

the sensor's unique identifier

public std::string location {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1a33441f14a76039c9d4339894a84ccf61}

The sensor's physical location, such as the body part where contact is made and measurements are taken.

public SensorInfo() {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1ad10862bee127453706c48bb8d5464fd1}

public SensorInfo(const SensorDeviceId & deviceId,const std::string & location) {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1a6c2dc7204ae56477904c733ab25e5aad}

public SensorInfo(const SensorInfo &) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1a669bf762f16a2b8621a7f49b38b5c811}

public SensorInfo(SensorInfo &&) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1ac7747904bcbc3126a7b6bae1bbf7d278}

public SensorInfo&operator=(const SensorInfo &) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1ae5db8c92bc7bb400dafb63ed1570b6df}

public SensorInfo&operator=(SensorInfo &&) = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1a91f2d35fbab3aa77328f7bf4e4552300}

public SensorInfo(const std::string & id,const std::string & subid,const std::string & location) {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1a8d72893432dd69f010295f226b8ac20b}

public virtual ~SensorInfo() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1a50e971bcb32cbde4ec311921da392a35}

public bool operator==(const SensorInfo & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1aa8f15ab11e5a77e0013faf62165264f3}

public bool operator<(const SensorInfo & rhs) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_sensor_info_1aeb183baf0916aaedf4c537287ceb4360}



class HP::Omnicept::Abi::SerializationError {#class_h_p_1_1_omnicept_1_1_abi_1_1_serialization_error}

class HP::Omnicept::Abi::SerializationError
  : public std::logic_error

Used for problems in serialization, meaning that a domain type could not be serialized/deserialized or that a nullptr was given.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public explicit SerializationError(const std::string & what_arg) | public explicit SerializationError(const char * what_arg) | public virtual ~SerializationError() = default |


Members

public explicit SerializationError(const std::string & what_arg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_serialization_error_1a106a38097c5090dd73a0a97dcd126231}

public explicit SerializationError(const char * what_arg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_serialization_error_1a6fc85001db97902b9cf130cc5c4764e9}

public virtual ~SerializationError() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_serialization_error_1a386f652da5f62f8e3f6043af094c0c0d}



class HP::Omnicept::Abi::SessionLicense {#class_h_p_1_1_omnicept_1_1_abi_1_1_session_license}

Session license information.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public SessionLicense(std::string clientId,std::string accessKey,LicensingModel requestedLicense,bool isRunningInEditor) | Used to store session license information. public bool operator==(const SessionLicense & other) const | public const std::string & getClientId() const | public const std::string & getAccessKey() const | public Abi::LicensingModel getRequestedLicense() const | public bool getIsRunningInEditor() const |


Members

public SessionLicense(std::string clientId,std::string accessKey,LicensingModel requestedLicense,bool isRunningInEditor) {#class_h_p_1_1_omnicept_1_1_abi_1_1_session_license_1af869a7928e484483d7f8fb17c6d72b8f}

Used to store session license information.

Parameters

  • clientId a unique string token as user identification

  • accessKey a unique string token tied to a user's application

  • requestedLicense the type of license

  • isRunningInEditor only relevent when requestedLicense is LicensingModel::ENTERPRISE. Should be set to true only if the license is being used for development.

public bool operator==(const SessionLicense & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_session_license_1a1f11204dd0902e06fb2fa7f4cad8f52d}

public const std::string & getClientId() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_session_license_1a308eed28ead2aff442523cbc4d549401}

public const std::string & getAccessKey() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_session_license_1a6ae8da44eebf4629cabb27f0be854cd6}

public Abi::LicensingModel getRequestedLicense() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_session_license_1a3ab92eeb8773933a7b81312e1fbc36b9}

public bool getIsRunningInEditor() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_session_license_1a4083e1a4733f3325c52fed0ae1e364e5}



class HP::Omnicept::Abi::Subscription {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription}

A Subscription is submitted to the HP Omnicept Runtime as part of a SubsriptionList to indicate that an extension wants to receive certain message types.

A Subscription can filter on messageType, sensorInfo, and sender. These different fields are combined through a logical AND. An unset field acts like a wildcard and is not used in the filtering process. For example, if a Subscription has only MessageType set, the a message only needs to have that MessageType in order to be allowed through. If a Subscription has a MessageType and sender, then a message needs to be of that MessageType and from that sender to be allowed through.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public Subscription() | public Subscription(MessageTypemessageType,constSensorInfo & sensorInfo,const std::string & sender) | public Subscription(uint32_t messageType,const SensorInfo & sensorInfo,const std::string & sender) | public virtual ~Subscription() | public const MessageType&getType() const | public const SensorInfo&getSensorInfo() const | public const std::string & getSender() const | public void setType(const MessageType & type) | public void setSensorInfo(const SensorInfo & sensorInfo) | public void setSender(const std::string & sender) | public bool operator==(const Subscription & other) const |


Members

public Subscription() {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1a64a2fe2c59e39349ae05acad341d2b0d}

public Subscription(MessageTypemessageType,constSensorInfo & sensorInfo,const std::string & sender) {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1abc52d85fe123b46416868acd26fa738f}

public Subscription(uint32_t messageType,const SensorInfo & sensorInfo,const std::string & sender) {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1adbaf5d60cd830414e4139fb67f796c2b}

public virtual ~Subscription() {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1a81b265f918ccc1734812888e6d6b969b}

public const MessageType&getType() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1a283f707b7b0872e2a1cf7eefdd047c0c}

public const SensorInfo&getSensorInfo() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1ab9f025e7b610c4dde7841d32ac549a89}

public const std::string & getSender() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1abb2e1217842c3e04c54195176e5e5b49}

public void setType(const MessageType & type) {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1a68fd5cee4f9d46a8e574b8fb9bda7cbf}

public void setSensorInfo(const SensorInfo & sensorInfo) {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1a9d227fccd9e4fa8ac354798bd6baa949}

public void setSender(const std::string & sender) {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1af5801769c17e875a708e73545e6c6994}

public bool operator==(const Subscription & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_1af0ff45db994fda05b942fb273ea60c27}



class HP::Omnicept::Abi::SubscriptionList {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_list}

Domain type for a SubscriptionList.

A SubscriptionList is a collection of Subscriptions, indicating what kinds of MessageTypes you want to receive. You will not be notified when you request types that you cannot receive. For example, if your license does not include access to a message type, or there are no attached sensors that produce the message type.

A narrow SubscriptionList can improve performance for both the Runtime and the extension. The Runtime performs a filtering function, so serialization and further processing is avoided for undesired messages.

When used for filtering, a message is allowed through the filter (ie. sent to an extension) when the message satisfies at least one Subscription in the subscription list.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public SubscriptionList() = default | The default constructor should not be used in place of GetSubscriptionListToNone(). public virtual ~SubscriptionList() = default | public const std::vector< Subscription> &getSubscriptions() const | public std::vector< Subscription> &getSubscriptions() | public void setSubscriptions(const std::vector< Subscription > & subscriptions) | public bool operator==(const SubscriptionList & other) const |


Members

public SubscriptionList() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_list_1a9f3551554e01b544e6070a4a00b3051f}

The default constructor should not be used in place of GetSubscriptionListToNone().

public virtual ~SubscriptionList() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_list_1ae0f64912a2e5d23c4ff75cdce9889a08}

public const std::vector< Subscription> &getSubscriptions() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_list_1a960970b881bb239af0649724f2f34b49}

public std::vector< Subscription> &getSubscriptions() {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_list_1a719dc76b7e40dac5c9b2091273ee41c6}

public void setSubscriptions(const std::vector< Subscription > & subscriptions) {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_list_1a15ab7550126fca3d3165e78099818ce5}

public bool operator==(const SubscriptionList & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_subscription_list_1a52daa7a5a9233e32528c468499f1e0e7}



class HP::Omnicept::Abi::Timestamp {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp}

Specifies the timestamp collection.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public int64_t systemTimeMicroSeconds | Measured when an Omnicept extension receives data from a device or generates a message. public int64_t hardwareTimeMicroSeconds | The time at which a sample was captured according to a sensor device's hardware clock, independent of system time. public int64_t omniceptTimeMicroSeconds | Synthetic timestamp used for sensor fusion based on hardware time and system time, provided on the system time timeline. public Timestamp() | public virtual ~Timestamp() = default | public bool operator==(const Timestamp & other) const |


Members

public int64_t systemTimeMicroSeconds {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_1a0f98b89f8670e1ea260506b25576c27d}

Measured when an Omnicept extension receives data from a device or generates a message.

public int64_t hardwareTimeMicroSeconds {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_1a7601ea8bc2876615550d4a8ba4701cf8}

The time at which a sample was captured according to a sensor device's hardware clock, independent of system time.

public int64_t omniceptTimeMicroSeconds {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_1a928e9de2783348df108171298e0a4727}

Synthetic timestamp used for sensor fusion based on hardware time and system time, provided on the system time timeline.

public Timestamp() {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_1a975cbb5ce9a9514ff596f5eebb870551}

public virtual ~Timestamp() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_1aeb68de9fe97721c1e2c021570dd8b8e7}

public bool operator==(const Timestamp & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_1a29cdff1fc2c753711ab1eb8132094f0e}



class HP::Omnicept::Abi::TimestampCalculator {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator}

Utility class to handle calculation of interpolated HW timestamps and OmniceptTimestamp.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public std::deque< PacketTimeInfo>packetTimeInfoQueue | public TimestampCalculator(double expectedSensorFrequency,size_t maxQueueSize) | public virtual ~TimestampCalculator() = default | public void addPacketTimeInfo(PacketTimeInfo timeInfo) | public NextTimestampResult getNextTimestamp() | public void notifyDeviceReset() | public double calculateSkew() |


Members

public std::deque< PacketTimeInfo>packetTimeInfoQueue {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1a8b4764de6e4c2795de68e75d94412967}

public TimestampCalculator(double expectedSensorFrequency,size_t maxQueueSize) {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1aabc6bf80a5c0eed5364c62762a966e70}

public virtual ~TimestampCalculator() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1a5a05c133ff3808911c1d142f130c528c}

public void addPacketTimeInfo(PacketTimeInfo timeInfo) {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1aeb5b9bd2afd3eb4bc6d0fe3d0499560a}

public NextTimestampResult getNextTimestamp() {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1a8d0e0bc781eee3ae41adadc0b1687cb2}

public void notifyDeviceReset() {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1adcdb3dab58f9bfaaffc46578bf83caf5}

public double calculateSkew() {#class_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1a1e2a717ffbf8d63b8a578afb4e973bbe}



class HP::Omnicept::Abi::TransportError {#class_h_p_1_1_omnicept_1_1_abi_1_1_transport_error}

class HP::Omnicept::Abi::TransportError
  : public std::logic_error

Used for problems in transport, meaning that the underlying transport mechanism could not send or receive bytes.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public explicit TransportError(const std::string & what_arg) | public explicit TransportError(const char * what_arg) | public virtual ~TransportError() = default |


Members

public explicit TransportError(const std::string & what_arg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_transport_error_1a357263df525c3dd0729f6af2805c8b4e}

public explicit TransportError(const char * what_arg) {#class_h_p_1_1_omnicept_1_1_abi_1_1_transport_error_1aba925e60c2f2168c7c34821a7b726e4e}

public virtual ~TransportError() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_transport_error_1aae457327ae71229da157270551ca8ed2}



class HP::Omnicept::Abi::VSync {#class_h_p_1_1_omnicept_1_1_abi_1_1_v_sync}

class HP::Omnicept::Abi::VSync
  : public HP::Omnicept::Abi::DomainData

Domain type for time facial camera shutter is open.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public VSync() | public virtual ~VSync() = default | public bool operator==(const VSync & other) const | public virtual bool dataEquals(const DomainData & other) const | public std::string toString() const |


Members

public VSync() {#class_h_p_1_1_omnicept_1_1_abi_1_1_v_sync_1a93d319c188aa53b7047e815db1a0e225}

public virtual ~VSync() = default {#class_h_p_1_1_omnicept_1_1_abi_1_1_v_sync_1a75ece401e07a6a0a584163e7d5ed66f8}

public bool operator==(const VSync & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_v_sync_1ab21ad8f691e124102b5bcedf0173a38c}

public virtual bool dataEquals(const DomainData & other) const {#class_h_p_1_1_omnicept_1_1_abi_1_1_v_sync_1a536075383789d5f9f60e67ea8fe632c2}

public std::string toString() const {#class_h_p_1_1_omnicept_1_1_abi_1_1_v_sync_1a0da6d95cb6db979f147a5f6e83024ba7}



struct HP::Omnicept::Abi::EyeGaze {#struct_h_p_1_1_omnicept_1_1_abi_1_1_eye_gaze}

Domain type for a normalized eye gaze vector.

Relative from the user: +x left, +y up, +z facing forward from the user.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public float x | public float y | public float z | public EyeGaze() | public EyeGaze(float x,float y,float z) | public bool operator==(const EyeGaze & other) const | public std::string toString() const |


Members

public float x {#struct_h_p_1_1_omnicept_1_1_abi_1_1_eye_gaze_1ace24a2e249b09a4dd66b509d2a27ed45}

public float y {#struct_h_p_1_1_omnicept_1_1_abi_1_1_eye_gaze_1a04d32230cafbcade69b565e988b43495}

public float z {#struct_h_p_1_1_omnicept_1_1_abi_1_1_eye_gaze_1a91314baefa38f2c9ccb5e8898714e493}

public EyeGaze() {#struct_h_p_1_1_omnicept_1_1_abi_1_1_eye_gaze_1aed5b194720e1a428347b57fef89e98ce}

public EyeGaze(float x,float y,float z) {#struct_h_p_1_1_omnicept_1_1_abi_1_1_eye_gaze_1ad1f7f2d8e3683f24fe8c9545c597ed60}

public bool operator==(const EyeGaze & other) const {#struct_h_p_1_1_omnicept_1_1_abi_1_1_eye_gaze_1ab155babf21f54d7ba2c810264c949363}

public std::string toString() const {#struct_h_p_1_1_omnicept_1_1_abi_1_1_eye_gaze_1aea7fadcd35f257bfe853ca9d08566767}



struct HP::Omnicept::Abi::PupilPosition {#struct_h_p_1_1_omnicept_1_1_abi_1_1_pupil_position}

Domain type for pupil position. Normailzed to a [0.f,1.f] 2d coordinate system.

Where x = 0.f, y = 0.f is top left, and x = 1.f, y = 1.f is bottom right of coordinate system from the user's perspective.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public float x | public float y | public PupilPosition() | public PupilPosition(float x,float y) | public bool operator==(const PupilPosition & other) const | public std::string toString() const |


Members

public float x {#struct_h_p_1_1_omnicept_1_1_abi_1_1_pupil_position_1a89aaa212822308681098df385eff672f}

public float y {#struct_h_p_1_1_omnicept_1_1_abi_1_1_pupil_position_1a45cb389bbe84621b7ad994d38cf5bc12}

public PupilPosition() {#struct_h_p_1_1_omnicept_1_1_abi_1_1_pupil_position_1a0d5ef50ebe01dd644e1a1e4518d22af2}

public PupilPosition(float x,float y) {#struct_h_p_1_1_omnicept_1_1_abi_1_1_pupil_position_1aebca216549a93e5bce2745ed92cd94a5}

public bool operator==(const PupilPosition & other) const {#struct_h_p_1_1_omnicept_1_1_abi_1_1_pupil_position_1aacbba603258ee9077ef0732742e672da}

public std::string toString() const {#struct_h_p_1_1_omnicept_1_1_abi_1_1_pupil_position_1a0cd1883f85bf1e5595a2934e99da48b3}



struct HP::Omnicept::Abi::Color {#struct_h_p_1_1_omnicept_1_1_abi_1_1_color}

Struct containing RGB and luminance values.

RGB values are non-linear, normalized [0,1] in the sRGB color space Luminance calculated using RGB converted to linear-light values.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public float r | Red [0.f,1.f]. public float g | Green [0.f,1.f]. public float b | Blue [0.f,1.f]. public float y | Luminance [0.f,1.f]. public Color() | public Color(float r,float g,float b,float y) | public virtual ~Color() = default | public bool operator==(const Color & other) const | public std::string toString() const |


Members

public float r {#struct_h_p_1_1_omnicept_1_1_abi_1_1_color_1af8da394dc9d60f28f39a04e362a2813e}

Red [0.f,1.f].

public float g {#struct_h_p_1_1_omnicept_1_1_abi_1_1_color_1a82e492ce4580c8c37ef5d6bbdae7d397}

Green [0.f,1.f].

public float b {#struct_h_p_1_1_omnicept_1_1_abi_1_1_color_1a4ff11f9cc917bc26698e50bcff7a5773}

Blue [0.f,1.f].

public float y {#struct_h_p_1_1_omnicept_1_1_abi_1_1_color_1accbfadb4d61a1343fa06d757a8d5cf3e}

Luminance [0.f,1.f].

public Color() {#struct_h_p_1_1_omnicept_1_1_abi_1_1_color_1ac22bf7ed802a111f38666bfebb018aaa}

public Color(float r,float g,float b,float y) {#struct_h_p_1_1_omnicept_1_1_abi_1_1_color_1a230663c17fb7657d74f3c42a246e3441}

public virtual ~Color() = default {#struct_h_p_1_1_omnicept_1_1_abi_1_1_color_1ac55e4714dddd09c93dba3ab87056c28f}

public bool operator==(const Color & other) const {#struct_h_p_1_1_omnicept_1_1_abi_1_1_color_1a6ad337d1c53a3b092ea521d8ed0694e4}

public std::string toString() const {#struct_h_p_1_1_omnicept_1_1_abi_1_1_color_1a5c1cb538aee71ca3b798a0e14988858f}



namespace HP::Omnicept::Utils {#namespace_h_p_1_1_omnicept_1_1_utils}

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- class HP::Omnicept::Utils::ThreadOwner | A simple mix-in to provide a consistent interface for starting and stopping threaded objects. Main purpose is to provide a consistent way to request threads to stop, otherwise just a very lean wrapper around std::thread. struct HP::Omnicept::Utils::IUuid | struct HP::Omnicept::Utils::FileSystem |



class HP::Omnicept::Utils::ThreadOwner {#class_h_p_1_1_omnicept_1_1_utils_1_1_thread_owner}

A simple mix-in to provide a consistent interface for starting and stopping threaded objects. Main purpose is to provide a consistent way to request threads to stop, otherwise just a very lean wrapper around std::thread.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public virtual ~ThreadOwner() | public virtual void start() | Start the thread inside this object. Idempotent. public virtual void requestStop() | Ask that this thread stops when it is convenient, asynchronously. public virtual bool join() | Joins the thread the thread whenever it completes, does not request a stop. public virtual bool shouldContinue() const | Checks if the Thread should continue or not. public std::thread::id getThreadId() const | Gets the thread id of this object's thread.


Members

public virtual ~ThreadOwner() {#class_h_p_1_1_omnicept_1_1_utils_1_1_thread_owner_1a2bd45a75fa1db9c8f9486f43b95b5ade}

public virtual void start() {#class_h_p_1_1_omnicept_1_1_utils_1_1_thread_owner_1acb27f70aa8cb4b11d3aea0fb2da7f5d1}

Start the thread inside this object. Idempotent.

public virtual void requestStop() {#class_h_p_1_1_omnicept_1_1_utils_1_1_thread_owner_1a0e6276f1c6d0a0ac644eba7cc5c63f57}

Ask that this thread stops when it is convenient, asynchronously.

public virtual bool join() {#class_h_p_1_1_omnicept_1_1_utils_1_1_thread_owner_1a423e0fa5d51f481ddda8d19ef8910d36}

Joins the thread the thread whenever it completes, does not request a stop.

Returns

False if the thread was not joinable. Indicates that either the thread is not running or that it was detached.

public virtual bool shouldContinue() const {#class_h_p_1_1_omnicept_1_1_utils_1_1_thread_owner_1a440a2e5413c90f4e4f4b9e949c8a0779}

Checks if the Thread should continue or not.

public std::thread::id getThreadId() const {#class_h_p_1_1_omnicept_1_1_utils_1_1_thread_owner_1a57498c68cae308608797588fc78c214d}

Gets the thread id of this object's thread.

Returns

this object's thread id if the thread is not null, otherwise returns a thread id that doesn't identify a thread



struct HP::Omnicept::Utils::IUuid {#struct_h_p_1_1_omnicept_1_1_utils_1_1_i_uuid}

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public IUuid() = default | public virtual ~IUuid() = default | public operator std::string() const |


Members

public IUuid() = default {#struct_h_p_1_1_omnicept_1_1_utils_1_1_i_uuid_1aab4a1f7a17bfacfcad757080db440a98}

public virtual ~IUuid() = default {#struct_h_p_1_1_omnicept_1_1_utils_1_1_i_uuid_1ad2bb7cb468ff32a05c283b67627637be}

public operator std::string() const {#struct_h_p_1_1_omnicept_1_1_utils_1_1_i_uuid_1abe9f1c240094005a77828b44d1eac43a}



struct HP::Omnicept::Utils::FileSystem {#struct_h_p_1_1_omnicept_1_1_utils_1_1_file_system}

Summary

Members | Descriptions
--------------------------------|---------------------------------------------


Members



class HP::Omnicept::Glia::AsyncClientBuilder {#class_h_p_1_1_omnicept_1_1_glia_1_1_async_client_builder}

A single use object that builds a Client connected to the HP Omnicept Runtime asynchronously.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public bool isClientBuildFinished() const | Can the Client be built without blocking. public bool isValid() const | Is the AsyncClientBuilder valid. public void waitForConnection() | Waits for the asynchronous thread building a connection to the HP Omnicept Runtime to finish. public std::unique_ptr< Client>getBuildClientResultOrThrow() | Waits for the asynchronous thread building the Client connection to the HP Omnicept Runtime to finish, and returns the Client if successfull, or throws an exception if it is not. public ~AsyncClientBuilder() = default | Destructor for AsyncClientBuilder. public AsyncClientBuilder(const AsyncClientBuilder &) = delete | public AsyncClientBuilder&operator=(const AsyncClientBuilder &) = delete | public AsyncClientBuilder(AsyncClientBuilder &&) = default | public AsyncClientBuilder&operator=(AsyncClientBuilder &&) = default |


Members

public bool isClientBuildFinished() const {#class_h_p_1_1_omnicept_1_1_glia_1_1_async_client_builder_1adb12344f9faaba0bd0f01e4711871bb3}

Can the Client be built without blocking.

Returns

true if the AsyncClientBuilderisValid, and the asynchronous thread building the Client has finished running.

public bool isValid() const {#class_h_p_1_1_omnicept_1_1_glia_1_1_async_client_builder_1acc6b2245971d9f9cbf3a749652ea6327}

Is the AsyncClientBuilder valid.

An AsyncClientBuilder is valid after construction until getBuildClientResultOrThrow is called, and will be invalid after that.

Returns

true if getBuildClientResultOrThrow has not been called yet.

public void waitForConnection() {#class_h_p_1_1_omnicept_1_1_glia_1_1_async_client_builder_1a1ec4d33a2fd0e5e6311cf619264684b2}

Waits for the asynchronous thread building a connection to the HP Omnicept Runtime to finish.

Upon returning, isClientBuildFinished will return true

Exceptions

public std::unique_ptr< Client>getBuildClientResultOrThrow() {#class_h_p_1_1_omnicept_1_1_glia_1_1_async_client_builder_1a838e3d5f93654b1a6cddf02c7885ab4e}

Waits for the asynchronous thread building the Client connection to the HP Omnicept Runtime to finish, and returns the Client if successfull, or throws an exception if it is not.

Will block calling thread until the asynchronous thread building the Client connection is finished unless isClientBuildFinished is true

Exceptions

  • [Abi::ProtocolError](#class_h_p_1_1_omnicept_1_1_abi_1_1_protocol_error) the client did not receive the message it was expecting when establishing the connection

  • [Abi::TransportError](#class_h_p_1_1_omnicept_1_1_abi_1_1_transport_error) the client was unable to connect to the HP Omnicept Runtime

  • [Abi::HandshakeError](#class_h_p_1_1_omnicept_1_1_abi_1_1_handshake_error) the handshake was rejected by the HP Omnicept Runtime

  • std::invalid_argument if invalid parameters were passed to the Client see exceptions listed in Client::Client for details

  • std::logic_error if the AsyncClientBuilder is no longer valid. Can check with isValid

Returns

a Client connected to the HP Omnicept Runtime

AsyncClientBuilder will be in an invalid state after this call until its destruction

public ~AsyncClientBuilder() = default {#class_h_p_1_1_omnicept_1_1_glia_1_1_async_client_builder_1a6602186f20a735268121d2e4f05ba8a1}

Destructor for AsyncClientBuilder.

the destructor will NOT wait for the asynchronous thread to finish.

public AsyncClientBuilder(const AsyncClientBuilder &) = delete {#class_h_p_1_1_omnicept_1_1_glia_1_1_async_client_builder_1a3a3c9441aeca2460f9cb8393eb919b83}

public AsyncClientBuilder&operator=(const AsyncClientBuilder &) = delete {#class_h_p_1_1_omnicept_1_1_glia_1_1_async_client_builder_1af4d0e3e5279b5c5e018b39d6e4764002}

public AsyncClientBuilder(AsyncClientBuilder &&) = default {#class_h_p_1_1_omnicept_1_1_glia_1_1_async_client_builder_1a48b35683209370dbb0634f99c5ffd2fd}

public AsyncClientBuilder&operator=(AsyncClientBuilder &&) = default {#class_h_p_1_1_omnicept_1_1_glia_1_1_async_client_builder_1a198e1e54f78030e19ad3e9a78a86fe39}



class ClientBuildHelpers {#class_client_build_helpers}

Utility class to take an asynchoronously building HP::Omnicept::Client and finishes building it, handling all exceptions that may get thrown.

Summary

Members | Descriptions
--------------------------------|---------------------------------------------


Members



class Semaphore {#class_semaphore}

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public inline Semaphore() | public inline explicit Semaphore(size_t count) | public virtual ~Semaphore() = default | public inline void notify(size_t count) | public inline void wait() |


Members

public inline Semaphore() {#class_semaphore_1ae32c955336ae9e60e20a3facde270714}

public inline explicit Semaphore(size_t count) {#class_semaphore_1a7a2a26421a05787ef830a7da142f7e2c}

public virtual ~Semaphore() = default {#class_semaphore_1afe6f223ac15578291dae69d6ea7c8422}

public inline void notify(size_t count) {#class_semaphore_1a58c1aed32d6c91de435681e98741af57}

public inline void wait() {#class_semaphore_1a85500356c2f7d1057d4568227e7f35b7}



class SessionLicenseHelper {#class_session_license_helper}

Utility class to prompt the user for formatted license input, and parse an HP::Omnicept::Abi::SessionLicense from command line arguments.

Summary

Members | Descriptions
--------------------------------|---------------------------------------------


Members



struct ClientBuildHelpers::BuildResult {#struct_client_build_helpers_1_1_build_result}

Stores the result of HP::Omnicept::Glia::AsyncClientBuilder::getBuildClientResultOrThrow.

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public std::unique_ptr< HP::Omnicept::Client>client | A client. Will be a nullptr if an exception occurred. public std::string errorMsg | Message of exception that was thrown when building the HP::Omnicept::Client, will be empty if building the client was successful.


Members

public std::unique_ptr< HP::Omnicept::Client>client {#struct_client_build_helpers_1_1_build_result_1ab754991992f708e7fc4153a36b055a94}

A client. Will be a nullptr if an exception occurred.

public std::string errorMsg {#struct_client_build_helpers_1_1_build_result_1acd033b9fd78b0f3c1c443b067f7807e5}

Message of exception that was thrown when building the HP::Omnicept::Client, will be empty if building the client was successful.



struct HP::Omnicept::Client::LastValueCached {#struct_h_p_1_1_omnicept_1_1_client_1_1_last_value_cached}

struct representing the result of Client::getLastData<DomainType>()

Parameters

  • DomainType the type of data

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public DomainType data | data stored in Client's lvc if valid is true, otherwise the default value of DomainType public bool valid | if data is valid.


Members

public DomainType data {#struct_h_p_1_1_omnicept_1_1_client_1_1_last_value_cached_1ad44a5088887611e0cd2d67f25c3a3e0c}

data stored in Client's lvc if valid is true, otherwise the default value of DomainType

public bool valid {#struct_h_p_1_1_omnicept_1_1_client_1_1_last_value_cached_1a66b0334266831c796b18b6872257b0bc}

if data is valid.



struct HP::Omnicept::Abi::TimestampCalculator::NextTimestampResult {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_next_timestamp_result}

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public int64_t hwInterpolatedTime | public int64_t omniceptTime |


Members

public int64_t hwInterpolatedTime {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_next_timestamp_result_1a851869ccf53759c585526fc08ced3a4f}

public int64_t omniceptTime {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_next_timestamp_result_1a3e58737ef195048ff2c87f6a585c0ba3}



struct HP::Omnicept::Abi::TimestampCalculator::PacketTimeInfo {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_packet_time_info}

Summary

Members | Descriptions
--------------------------------|--------------------------------------------- public int64_t hwTime | public int64_t sysTime | public uint8_t numSamples | public int64_t sysDiff | public int64_t hwDiff | public double instantSkew | public inline PacketTimeInfo(int64_t hw,int64_t sys,uint8_t num,int64_t sysD,int64_t hwD,double iSkew) |


Members

public int64_t hwTime {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_packet_time_info_1a07deddeaaec07201ee180474d8eecf8f}

public int64_t sysTime {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_packet_time_info_1ac815e45eb84ab4ff0b9e3da669c6ec56}

public uint8_t numSamples {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_packet_time_info_1a44b61f66c8990c4f1acf1f8e2b087b73}

public int64_t sysDiff {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_packet_time_info_1a0e56baa8bb2fd91d675fae79e1fe7322}

public int64_t hwDiff {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_packet_time_info_1a0126e8be03f9a4c7936b04e2b9c9b7d7}

public double instantSkew {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_packet_time_info_1adb1703bf9bfe52d4b10f295e6d2eb6c6}

public inline PacketTimeInfo(int64_t hw,int64_t sys,uint8_t num,int64_t sysD,int64_t hwD,double iSkew) {#struct_h_p_1_1_omnicept_1_1_abi_1_1_timestamp_calculator_1_1_packet_time_info_1a3ee2bbd13cc0c7a120f7bfacac74fa1c}