C++ Reference

Summary

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



namespace HP::Omnicept

Summary

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



class HP::Omnicept::Glia

Entry point in to the HP Omnicept SDK.

Summary

Members Descriptions
publicGlia() = delete


Members

publicGlia() = delete



class HP::Omnicept::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()
publicResultstartClient() If the Client's State is State::PAUSED changes the Client's State to State::RUNNING.
publicResultpauseClient() If the Client's State is State::RUNNING changes the Client's State to State::PAUSED.
publicResultdisconnectClient() If the Client's State is not State::DISCONNECTED changes the Client's State to State::DISCONNECTED.
public template<>
ResultregisterCallback(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<>
inlineResultunregisterCallback()
Takes a DomainType as a template parameter and unregisters the function to be called for a specific DomainType.
public template<>
inline boolisCallbackRegisteredForType()
Takes a DomainType as a template parameter and checks if a callback function is registered for the specified DomainType.
public voidclearAllCallbacks() 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.
publicResultstartDataRecord(std::function< void(std::shared_ptr<Abi::DataVaultResult >)> dvrCallback) Start recording all DomainType messages data send to HP Omnicept Runtime.
publicResultstopDataRecord() Stop recording all DomainType messages data send to HP Omnicept Runtime.
publicStategetClientState() const Gets the current State of the Client.
publicResultsetSubscriptions(constAbi::SubscriptionList& subList) Tells the Client what messages to ask the HP Omnicept Runtime for.
enumState Enum representing the state of the Client.
enumResult Enum representing a result from operations on the Client The success of some operations are dependent on the Client's Client::State.
typedefStateCallback_T


Members

public virtual~Client()

publicResultstartClient()

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:

publicResultpauseClient()

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

Returns

result which will be:

publicResultdisconnectClient()

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

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<>
inlineResultunregisterCallback()

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 boolisCallbackRegisteredForType()

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 voidclearAllCallbacks()

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.

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.

publicResultstartDataRecord(std::function< void(std::shared_ptr<Abi::DataVaultResult >)> dvrCallback)

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:

publicResultstopDataRecord()

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

Returns

result which will be:

publicStategetClientState() const

Gets the current State of the Client.

Returns

the Client's State

publicResultsetSubscriptions(constAbi::SubscriptionList& subList)

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:

enumState

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.

enumResult

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.

typedefStateCallback_T



namespace HP::Omnicept::Abi

Summary

Members Descriptions
enumCognitiveLoadTargetModel
enumConfigurationErrorCode_t
enumDataVaultResultType
enumDataVaultResultErrorType
enumWhichEye
enumLicensingModel enum representing Licensing Model for Omnicept
enumMessageType
enumModuleControlSignalType enum representing types of ModuleControlSignal
public std::ostream &operator<<(std::ostream & out,constBackpackColorZone&)
public std::ostream &operator<<(std::ostream & out,constBattery&)
public std::ostream &operator<<(std::ostream & out,constByteMessage&)
public std::ostream &operator<<(std::ostream & out,constCameraImage&)
public std::ostream &operator<<(std::ostream & out,constCognitiveLoad&)
public std::ostream &operator<<(std::ostream & out,constNDimArrayFloat&)
public std::ostream &operator<<(std::ostream & out,constCognitiveLoadInputFeature&)
public std::ostream &operator<<(std::ostream & out,constHP::Omnicept::Abi::ConnectionIdentifier& cId)
public booloperator==(constConnectionIdentifier& lhs,const std::string & rhs)
public booloperator!=(constConnectionIdentifier& lhs,const std::string & rhs)
public booloperator<(constConnectionIdentifier& lhs,const std::string & rhs)
public booloperator>(constConnectionIdentifier& lhs,const std::string & rhs)
public booloperator<=(constConnectionIdentifier& lhs,const std::string & rhs)
public booloperator>=(constConnectionIdentifier& lhs,const std::string & rhs)
public template<>
std::ostream &operator<<(std::ostream & out,constDataFrame< T > & f)
public std::ostream &operator<<(std::ostream & out,constDataVaultResult& bvr)
public std::ostream &operator<<(std::ostream & out,constEyePupilDiameter& epd)
public std::ostream &operator<<(std::ostream & out,constEyePupillometry& ep)
public std::ostream &operator<<(std::ostream & out,constEyeGaze& eg)
public std::ostream &operator<<(std::ostream & out,constPupilPosition& ep)
public std::ostream &operator<<(std::ostream & out,constEyeTracking& et)
public std::ostream &operator<<(std::ostream & out,constHeartRate&)
public std::ostream &operator<<(std::ostream & out,constHeartRateVariability&)
public std::ostream &operator<<(std::ostream & out,constIMU3AxisValues& imu3ax)
public std::ostream &operator<<(std::ostream & out,constIMU&)
public std::ostream &operator<<(std::ostream & out,constPPG&)
public std::ostream &operator<<(std::ostream & out,constPPGFrame&)
public std::ostream &operator<<(std::ostream & out,constSceneColor&)
public std::ostream &operator<<(std::ostream & out,constSceneColorFrame&)
public std::ostream &operator<<(std::ostream & out,constVSync&)
classHP::Omnicept::Abi::BackpackColorZone
classHP::Omnicept::Abi::BackpackColors
classHP::Omnicept::Abi::Battery Domain type for battery data.
classHP::Omnicept::Abi::ByteMessage Domain type for byte message data.
classHP::Omnicept::Abi::CameraImage Domain type for Camera Image data.
classHP::Omnicept::Abi::CognitiveLoad Domain type for Cognitive Load prediction.
classHP::Omnicept::Abi::NDimArrayFloat
classHP::Omnicept::Abi::CognitiveLoadInputFeature Domain type for Cognitive Load Input Feature data.
classHP::Omnicept::Abi::ConfigurationError Used for problems with accessing or performing operations on configuration files and values.
classHP::Omnicept::Abi::ConnectionError Used for problems in connection, meaning that the underlying connection mechanism failed.
classHP::Omnicept::Abi::ConnectionIdentifier A unique identifier for each connection in HP Omnicept.
classHP::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.
classHP::Omnicept::Abi::DataVaultResult A composite message to indicate DataVault recording result from a request to start or stop a DataVault recording.
classHP::Omnicept::Abi::Dependency Domain type for a Dependency.
classHP::Omnicept::Abi::DependencyList Domain type for a DependencyList.
classHP::Omnicept::Abi::DomainData Base class for filterable timestamped domain type data.
classHP::Omnicept::Abi::EyePupilDiameter Domain type for eye pupil data.
classHP::Omnicept::Abi::EyePupillometry Domain type for both eye's eye pupil data.
classHP::Omnicept::Abi::EyePupillometryFrame Domain type for EyePupillometry frame data.
classHP::Omnicept::Abi::EyeTracking Domain type for eye tracking data.
classHP::Omnicept::Abi::EyeTrackingFrame Domain type for EyeTracking frame data.
classHP::Omnicept::Abi::GenericMessage Base class for all domain types.
classHP::Omnicept::Abi::HandshakeError Used for failures during the the handshake that attempts to create a connection between a client and the HP Omnicept Runtime.
classHP::Omnicept::Abi::HeartRate Domain type for heart rate data.
classHP::Omnicept::Abi::HeartRateFrame Domain type for HeartRate Frames.
classHP::Omnicept::Abi::HeartRateVariability Domain type for heart rate variability data.
classHP::Omnicept::Abi::IMessage ABC for all messages, the intermediate step between domain types and serialized bytes.
classHP::Omnicept::Abi::IMU3AxisValues
classHP::Omnicept::Abi::IMU Domain type for inertial measurement unit (IMU) data.
classHP::Omnicept::Abi::IMUFrame Domain type for IMU Frames.
classHP::Omnicept::Abi::MessageTypeUtils
classHP::Omnicept::Abi::ModuleControlSignal Domain type for status signals between the HP Omnicept Runtime and its connections.
classHP::Omnicept::Abi::PPG Domain type for photoplethysmography (PPG) data.
classHP::Omnicept::Abi::PPGFrame Domain type for PPG Frames.
classHP::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.
classHP::Omnicept::Abi::EyeSceneColors Domain type for eye average color and brightness.
classHP::Omnicept::Abi::SceneColor Domain type for HMD average color and brightness.
classHP::Omnicept::Abi::SceneColorFrame Domain type for Framed SceneColors.
classHP::Omnicept::Abi::SensorDeviceId Uniquely identifies a sensor.
classHP::Omnicept::Abi::SensorInfo Uniquely identifies a sensor and provides filterable or configurable information about it.
classHP::Omnicept::Abi::SerializationError Used for problems in serialization, meaning that a domain type could not be serialized/deserialized or that a nullptr was given.
classHP::Omnicept::Abi::SessionLicense Session license information.
classHP::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.
classHP::Omnicept::Abi::SubscriptionList Domain type for a SubscriptionList.
classHP::Omnicept::Abi::Timestamp Specifies the timestamp collection.
classHP::Omnicept::Abi::TimestampCalculator Utility class to handle calculation of interpolated HW timestamps and OmniceptTimestamp.
classHP::Omnicept::Abi::TransportError Used for problems in transport, meaning that the underlying transport mechanism could not send or receive bytes.
classHP::Omnicept::Abi::VSync Domain type for time facial camera shutter is open.
structHP::Omnicept::Abi::EyeGaze Domain type for a normalized eye gaze vector.
structHP::Omnicept::Abi::PupilPosition Domain type for pupil position. Normailzed to a [0.f,1.f] 2d coordinate system.
structHP::Omnicept::Abi::Color Struct containing RGB and luminance values.

Members

enumCognitiveLoadTargetModel

Values Descriptions
UNKNOWN
EYE_TRACKING
EYE_TRACKING_PPG

enumConfigurationErrorCode_t

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

enumDataVaultResultType

Values Descriptions
UNKNOWN
RECORDING_STARTED
RECORDING_START_REJECTED
RECORDING_STOPPED
RECORDING_STOP_REJECTED
RECORDING_ERROR

enumDataVaultResultErrorType

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

enumWhichEye

Values Descriptions
unknown
left
right
both

enumLicensingModel

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

enumMessageType

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

enumModuleControlSignalType

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,constBackpackColorZone&)

public std::ostream &operator<<(std::ostream & out,constBattery&)

public std::ostream &operator<<(std::ostream & out,constByteMessage&)

public std::ostream &operator<<(std::ostream & out,constCameraImage&)

public std::ostream &operator<<(std::ostream & out,constCognitiveLoad&)

public std::ostream &operator<<(std::ostream & out,constNDimArrayFloat&)

public std::ostream &operator<<(std::ostream & out,constCognitiveLoadInputFeature&)

public std::ostream &operator<<(std::ostream & out,constHP::Omnicept::Abi::ConnectionIdentifier& cId)

public booloperator==(constConnectionIdentifier& lhs,const std::string & rhs)

public booloperator!=(constConnectionIdentifier& lhs,const std::string & rhs)

public booloperator<(constConnectionIdentifier& lhs,const std::string & rhs)

public booloperator>(constConnectionIdentifier& lhs,const std::string & rhs)

public booloperator<=(constConnectionIdentifier& lhs,const std::string & rhs)

public booloperator>=(constConnectionIdentifier& lhs,const std::string & rhs)

public template<>
std::ostream &operator<<(std::ostream & out,constDataFrame< T > & f)

public std::ostream &operator<<(std::ostream & out,constDataVaultResult& bvr)

public std::ostream &operator<<(std::ostream & out,constEyePupilDiameter& epd)

public std::ostream &operator<<(std::ostream & out,constEyePupillometry& ep)

public std::ostream &operator<<(std::ostream & out,constEyeGaze& eg)

public std::ostream &operator<<(std::ostream & out,constPupilPosition& ep)

public std::ostream &operator<<(std::ostream & out,constEyeTracking& et)

public std::ostream &operator<<(std::ostream & out,constHeartRate&)

public std::ostream &operator<<(std::ostream & out,constHeartRateVariability&)

public std::ostream &operator<<(std::ostream & out,constIMU3AxisValues& imu3ax)

public std::ostream &operator<<(std::ostream & out,constIMU&)

public std::ostream &operator<<(std::ostream & out,constPPG&)

public std::ostream &operator<<(std::ostream & out,constPPGFrame&)

public std::ostream &operator<<(std::ostream & out,constSceneColor&)

public std::ostream &operator<<(std::ostream & out,constSceneColorFrame&)

public std::ostream &operator<<(std::ostream & out,constVSync&)



class HP::Omnicept::Abi::BackpackColorZone

Summary

Members Descriptions
public uint32_tr
public uint32_tg
public uint32_tb
publicBackpackColorZone() = default
publicBackpackColorZone(uint32_t r,uint32_t g,uint32_t b)
public virtual~BackpackColorZone() = default
public booloperator==(constBackpackColorZone& other) const


Members

public uint32_tr

public uint32_tg

public uint32_tb

publicBackpackColorZone() = default

publicBackpackColorZone(uint32_t r,uint32_t g,uint32_t b)

public virtual~BackpackColorZone() = default

public booloperator==(constBackpackColorZone& other) const



class HP::Omnicept::Abi::BackpackColors

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

Summary

Members Descriptions
publicBackpackColors()
publicBackpackColors(const std::vector<BackpackColorZone> & zones)
public virtual~BackpackColors() = default
public std::vector<BackpackColorZone> &getColorZones()
public const std::vector<BackpackColorZone> &getColorZones() const
public booloperator==(constBackpackColors& other) const


Members

publicBackpackColors()

publicBackpackColors(const std::vector<BackpackColorZone> & zones)

public virtual~BackpackColors() = default

public std::vector<BackpackColorZone> &getColorZones()

public const std::vector<BackpackColorZone> &getColorZones() const

public booloperator==(constBackpackColors& other) const



class HP::Omnicept::Abi::Battery

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

Domain type for battery data.

Summary

Members Descriptions
public unsigned intid
public boolisPresent
public floatpercent
publicBattery()
public virtual~Battery()
public booloperator==(constBattery& other) const
public std::stringtoString() const


Members

public unsigned intid

public boolisPresent

public floatpercent

publicBattery()

public virtual~Battery()

public booloperator==(constBattery& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::ByteMessage

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

Domain type for byte message data.

Summary

Members Descriptions
public std::stringid Identifier for the type of message.
public std::stringmessage Body of the message as a string of bytes.
publicByteMessage()
publicByteMessage(std::string id,std::string msg)
public virtual~ByteMessage()
public booloperator==(constByteMessage& other) const


Members

public std::stringid

Identifier for the type of message.

public std::stringmessage

Body of the message as a string of bytes.

publicByteMessage()

publicByteMessage(std::string id,std::string msg)

public virtual~ByteMessage()

public booloperator==(constByteMessage& other) const



class HP::Omnicept::Abi::CameraImage

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.
publicImageFormatformat The specific arrangement of bytes for the data in imageData e.g. YUY2.
public uint32_twidth Width of image in number of pixels.
public uint32_theight Height of image in number of pixels.
public uint64_tframeNumber Sequential image number for the frame.
public floatframesPerSecond Number of frames camera captures per second.
publicCameraImage()
public virtual~CameraImage() = default
public booloperator==(constCameraImage& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const
enumImageFormat


Members

public std::vector< unsigned char >imageData

Container of bytes that contains image data in format.

publicImageFormatformat

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

public uint32_twidth

Width of image in number of pixels.

public uint32_theight

Height of image in number of pixels.

public uint64_tframeNumber

Sequential image number for the frame.

public floatframesPerSecond

Number of frames camera captures per second.

publicCameraImage()

public virtual~CameraImage() = default

public booloperator==(constCameraImage& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const

enumImageFormat

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



class HP::Omnicept::Abi::CognitiveLoad

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

Domain type for Cognitive Load prediction.

Summary

Members Descriptions
public floatcognitiveLoad 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 floatstandardDeviation A prediction error considering cognitive load as the center of a normal distribution.
publicCognitiveLoad()
public virtual~CognitiveLoad() = default
public booloperator==(constCognitiveLoad& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const


Members

public floatcognitiveLoad

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 floatstandardDeviation

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

publicCognitiveLoad()

public virtual~CognitiveLoad() = default

public booloperator==(constCognitiveLoad& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::NDimArrayFloat

Summary

Members Descriptions
public std::vector< uint32_t >shape
public std::vector< float >valuesFlat
publicNDimArrayFloat() = default
public virtual~NDimArrayFloat() = default
public booloperator==(constNDimArrayFloat& other) const
public std::stringtoString() const


Members

public std::vector< uint32_t >shape

public std::vector< float >valuesFlat

publicNDimArrayFloat() = default

public virtual~NDimArrayFloat() = default

public booloperator==(constNDimArrayFloat& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::CognitiveLoadInputFeature

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

Domain type for Cognitive Load Input Feature data.

Summary

Members Descriptions
public std::stringdataState
publicTimestampstartDataCollectTime
publicTimestampendDataCollectTime
publicNDimArrayFloatfeatures
publicCognitiveLoadTargetModeltargetModel
publicCognitiveLoadInputFeature()
public virtual~CognitiveLoadInputFeature() = default
public booloperator==(constCognitiveLoadInputFeature& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const


Members

public std::stringdataState

publicTimestampstartDataCollectTime

publicTimestampendDataCollectTime

publicNDimArrayFloatfeatures

publicCognitiveLoadTargetModeltargetModel

publicCognitiveLoadInputFeature()

public virtual~CognitiveLoadInputFeature() = default

public booloperator==(constCognitiveLoadInputFeature& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::ConfigurationError

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
publicConfigurationErrorCode_tm_errorCode
public explicitConfigurationError(const std::string & what_arg,constConfigurationErrorCode_terrorCode)
public explicitConfigurationError(const char * what_arg,constConfigurationErrorCode_terrorCode)
public virtual~ConfigurationError() = default


Members

publicConfigurationErrorCode_tm_errorCode

public explicitConfigurationError(const std::string & what_arg,constConfigurationErrorCode_terrorCode)

public explicitConfigurationError(const char * what_arg,constConfigurationErrorCode_terrorCode)

public virtual~ConfigurationError() = default



class HP::Omnicept::Abi::ConnectionError

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 explicitConnectionError(const std::string & what_arg)
public explicitConnectionError(const char * what_arg)
public virtual~ConnectionError() = default


Members

public explicitConnectionError(const std::string & what_arg)

public explicitConnectionError(const char * what_arg)

public virtual~ConnectionError() = default



class HP::Omnicept::Abi::ConnectionIdentifier

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
publicConnectionIdentifier(const std::string connectionName,const std::string uuid) Constructs a ConnectionIdentifier.
publicConnectionIdentifier(const std::string identifier) Constructs a ConnectionIdentifier.
publicConnectionIdentifier(const std::string connectionName,constHP::Omnicept::Utils::IUuid& uuid) Constructs a ConnectionIdentifier.
public std::stringgetConnectionName() const Gets the ConnectionIdentifier's connection name.
public std::stringgetUuid() const Gets the ConnectionIdentifier's uuid as a string.
publicConnectionIdentifier() = delete
publicConnectionIdentifier(constConnectionIdentifier&) = default
publicConnectionIdentifier(ConnectionIdentifier&&) = default
publicConnectionIdentifier&operator=(constConnectionIdentifier&) = default
publicConnectionIdentifier&operator=(ConnectionIdentifier&&) = default
publicoperator std::string() const
public booloperator==(constConnectionIdentifier& other) const
public booloperator!=(constConnectionIdentifier& other) const
public booloperator<(constConnectionIdentifier& other) const
public booloperator>(constConnectionIdentifier& other) const
public booloperator<=(constConnectionIdentifier& other) const
public booloperator>=(constConnectionIdentifier& other) const


Members

publicConnectionIdentifier(const std::string connectionName,const std::string uuid)

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

publicConnectionIdentifier(const std::string identifier)

Constructs a ConnectionIdentifier.

Parameters

Exceptions

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

publicConnectionIdentifier(const std::string connectionName,constHP::Omnicept::Utils::IUuid& uuid)

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::stringgetConnectionName() const

Gets the ConnectionIdentifier's connection name.

Returns

the ConnectionIdentifier's connection name

public std::stringgetUuid() const

Gets the ConnectionIdentifier's uuid as a string.

Returns

the ConnectionIdentifier's uuid as a string

publicConnectionIdentifier() = delete

publicConnectionIdentifier(constConnectionIdentifier&) = default

publicConnectionIdentifier(ConnectionIdentifier&&) = default

publicConnectionIdentifier&operator=(constConnectionIdentifier&) = default

publicConnectionIdentifier&operator=(ConnectionIdentifier&&) = default

publicoperator std::string() const

public booloperator==(constConnectionIdentifier& other) const

public booloperator!=(constConnectionIdentifier& other) const

public booloperator<(constConnectionIdentifier& other) const

public booloperator>(constConnectionIdentifier& other) const

public booloperator<=(constConnectionIdentifier& other) const

public booloperator>=(constConnectionIdentifier& other) const



class HP::Omnicept::Abi::DataFrame

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
publicDataFrame(MessageTypevalue)
public virtual~DataFrame() = default
public std::stringtoString() const
public template<>
inline booloperator==(constDataFrame< T > & other) const
public inline virtual booldataEquals(constDomainData& other) const
public inline booldataEquals(constDataFrame< T > & other) const


Members

public std::vector< T >data

publicDataFrame(MessageTypevalue)

public virtual~DataFrame() = default

public std::stringtoString() const

public template<>
inline booloperator==(constDataFrame< T > & other) const

public inline virtual booldataEquals(constDomainData& other) const

public inline booldataEquals(constDataFrame< T > & other) const



class HP::Omnicept::Abi::DataVaultResult

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
publicDataVaultResultTypem_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.
publicDataVaultResultErrorTypem_error Error from a DataVault request. There is no error if the value is DataVaultResultErrorType::SUCCESS_NO_ERROR.
public std::stringm_sessionId The sessionId for a successfully started DataVault recording. Only set if m_result is DataVaultResultType::RECORDING_STARTED.
publicDataVaultResult()
publicDataVaultResult(DataVaultResultTyperesult,DataVaultResultErrorTypeerror,std::string sessionId)
public std::stringtoString() const
public booloperator==(constDataVaultResult& rhs) const


Members

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

publicDataVaultResultErrorTypem_error

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

public std::stringm_sessionId

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

publicDataVaultResult()

publicDataVaultResult(DataVaultResultTyperesult,DataVaultResultErrorTypeerror,std::string sessionId)

public std::stringtoString() const

public booloperator==(constDataVaultResult& rhs) const



class HP::Omnicept::Abi::Dependency

Domain type for a Dependency.

Summary

Members Descriptions
publicDependency() = default Create Dependency.
public explicitDependency(std::map< std::string, std::string > initial) Create Dependency from map.
public explicitDependency(const std::string & initial) Create Dependency from string.
public virtual~Dependency() = default Default destructor for Dependency.
public boolhas(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_tsize() const noexcept Retrieve number of attributes.
public voidadd(const std::string & key,const std::string & value) Adds specified attribute.
public voidremove(const std::string & key) Removes specified attribute.
public booloperator==(constDependency& other) const
public booloperator!=(constDependency& other) const


Members

publicDependency() = default

Create Dependency.

public explicitDependency(std::map< std::string, std::string > initial)

Create Dependency from map.

Parameters

  • initial a map

public explicitDependency(const std::string & initial)

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

Default destructor for Dependency.

public boolhas(const std::string & key) const

Checks if attribute exist.

Parameters

  • key name of the attribute

Returns

true if exist, else false

public std::vector< std::string >attributes() const

Return all attributes.

Returns

attributes in this instance

public const std::string &get(const std::string & key) const

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_tsize() const noexcept

Retrieve number of attributes.

Returns

number of attributes

public voidadd(const std::string & key,const std::string & value)

Adds specified attribute.

Parameters

  • key name of the attribute

  • value value of the attribute

public voidremove(const std::string & key)

Removes specified attribute.

Parameters

  • key name of the attribute

public booloperator==(constDependency& other) const

public booloperator!=(constDependency& other) const



class HP::Omnicept::Abi::DependencyList

Domain type for a DependencyList.

Summary

Members Descriptions
publicDependencyList() = default
public explicitDependencyList(std::vector<Dependency>)
public virtual~DependencyList() = default
public boolhas(constDependency& dependency) const Checks if dependency exist.
public std::size_tsize() const noexcept Retrieve number of attributes.
public voidadd(constDependency& dependency) Adds specified dependency.
public voidremove(constDependency& dependency) Removes specified dependency.
public booloperator==(constDependencyList& other) const
public booloperator!=(constDependencyList& other) const


Members

publicDependencyList() = default

public explicitDependencyList(std::vector<Dependency>)

public virtual~DependencyList() = default

public boolhas(constDependency& dependency) const

Checks if dependency exist.

Parameters

  • dependency dependency to check

Returns

true if exist, else false

public std::size_tsize() const noexcept

Retrieve number of attributes.

Returns

number of attributes

public voidadd(constDependency& dependency)

Adds specified dependency.

Parameters

  • dependency the dependency to add

public voidremove(constDependency& dependency)

Removes specified dependency.

Parameters

  • dependency the dependency to remove

public booloperator==(constDependencyList& other) const

public booloperator!=(constDependencyList& other) const



class HP::Omnicept::Abi::DomainData

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

Base class for filterable timestamped domain type data.

Summary

Members Descriptions
publicSensorInfosensorInfo
publicTimestamptimestamp
publicDomainData() = delete
public virtual~DomainData() = default
public std::stringtoString() const
public booloperator==(constDomainData& other) const
public booldataEquals(constDomainData& other) const


Members

publicSensorInfosensorInfo

publicTimestamptimestamp

publicDomainData() = delete

public virtual~DomainData() = default

public std::stringtoString() const

public booloperator==(constDomainData& other) const

public booldataEquals(constDomainData& other) const



class HP::Omnicept::Abi::EyePupilDiameter

Domain type for eye pupil data.

Summary

Members Descriptions
public floatsize Approximate pupil diameter in millimeters.
public floatconfidence Confidence in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.
publicEyePupilDiameter()
publicEyePupilDiameter(float size,float confidence)
public virtual~EyePupilDiameter() = default
public booloperator==(constEyePupilDiameter& other) const
public std::stringtoString() const


Members

public floatsize

Approximate pupil diameter in millimeters.

public floatconfidence

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

publicEyePupilDiameter()

publicEyePupilDiameter(float size,float confidence)

public virtual~EyePupilDiameter() = default

public booloperator==(constEyePupilDiameter& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::EyePupillometry

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

Domain type for both eye's eye pupil data.

Summary

Members Descriptions
publicEyePupilDiameterrightPupilDiameter EyePupilDiameter for right eye.
publicEyePupilDiameterleftPupilDiameter EyePupilDiameter for left eye.
publicEyePupillometry()
publicEyePupillometry(EyePupilDiameterleft,EyePupilDiameterright)
public virtual~EyePupillometry() = default
public booloperator==(constEyePupillometry& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const


Members

publicEyePupilDiameterrightPupilDiameter

EyePupilDiameter for right eye.

publicEyePupilDiameterleftPupilDiameter

EyePupilDiameter for left eye.

publicEyePupillometry()

publicEyePupillometry(EyePupilDiameterleft,EyePupilDiameterright)

public virtual~EyePupillometry() = default

public booloperator==(constEyePupillometry& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::EyePupillometryFrame

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

Domain type for EyePupillometry frame data.

Summary

Members Descriptions
publicEyePupillometryFrame()
public virtual~EyePupillometryFrame() = default


Members

publicEyePupillometryFrame()

public virtual~EyePupillometryFrame() = default



class HP::Omnicept::Abi::EyeTracking

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

Domain type for eye tracking data.

Summary

Members Descriptions
publicEyeGazeleftGaze EyeGaze for left eye.
public floatleftGazeConfidence Confidence for leftGaze in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.
publicEyeGazerightGaze EyeGaze for right eye.
public floatrightGazeConfidence Confidence for rightGaze in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.
publicEyeGazecombinedGaze Combined EyeGaze.
public floatcombinedGazeConfidence Confidence combinedGaze in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.
public floatleftPupilDilation Left eye pupil dilation in millimeters.
public floatleftPupilDilationConfidence Confidence for leftPupilDilation in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.
public floatrightPupilDilation Right eye pupil dilation in millimeters.
public floatrightPupilDilationConfidence Confidence for rightPupilDilation in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.
publicPupilPositionleftPupilPosition PupilPosition of left pupil.
public floatleftPupilPositionConfidence Confidence for leftPupilPositionConfidence in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.
publicPupilPositionrightPupilPosition PupilPosition of right pupil.
public floatrightPupilPositionConfidence Confidence for rightPupilPositionConfidence in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.
public floatleftEyeOpenness Left eye openness 0.f = closed 1.f = open.
public floatleftEyeOpennessConfidence Confidence for leftEyeOpenness in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.
public floatrightEyeOpenness Right eye openness 0.f = closed 1.f = open.
public floatrightEyeOpennessConfidence Confidence for rightEyeOpenness in range of [0.f, 1.f] where 0.f = invalid, 1.f = valid.
publicEyeTracking()
public virtual~EyeTracking() = default
public booloperator==(constEyeTracking& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const


Members

publicEyeGazeleftGaze

EyeGaze for left eye.

public floatleftGazeConfidence

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

publicEyeGazerightGaze

EyeGaze for right eye.

public floatrightGazeConfidence

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

publicEyeGazecombinedGaze

Combined EyeGaze.

public floatcombinedGazeConfidence

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

public floatleftPupilDilation

Left eye pupil dilation in millimeters.

public floatleftPupilDilationConfidence

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

public floatrightPupilDilation

Right eye pupil dilation in millimeters.

public floatrightPupilDilationConfidence

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

publicPupilPositionleftPupilPosition

PupilPosition of left pupil.

public floatleftPupilPositionConfidence

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

publicPupilPositionrightPupilPosition

PupilPosition of right pupil.

public floatrightPupilPositionConfidence

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

public floatleftEyeOpenness

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

public floatleftEyeOpennessConfidence

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

public floatrightEyeOpenness

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

public floatrightEyeOpennessConfidence

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

publicEyeTracking()

public virtual~EyeTracking() = default

public booloperator==(constEyeTracking& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::EyeTrackingFrame

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

Domain type for EyeTracking frame data.

Summary

Members Descriptions
publicEyeTrackingFrame()
public virtual~EyeTrackingFrame() = default


Members

publicEyeTrackingFrame()

public virtual~EyeTrackingFrame() = default



class HP::Omnicept::Abi::GenericMessage

Base class for all domain types.

Summary

Members Descriptions
publicGenericMessage() = delete
publicGenericMessage(MessageTypemsgType)
public virtual~GenericMessage() = default
publicMessageTypegetMessageType() const
public booloperator==(constGenericMessage& other) const


Members

publicGenericMessage() = delete

publicGenericMessage(MessageTypemsgType)

public virtual~GenericMessage() = default

publicMessageTypegetMessageType() const

public booloperator==(constGenericMessage& other) const



class HP::Omnicept::Abi::HandshakeError

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 explicitHandshakeError(const std::string & what_arg)
public explicitHandshakeError(const char * what_arg)
public const char *what() const
public virtual~HandshakeError() = default


Members

public explicitHandshakeError(const std::string & what_arg)

public explicitHandshakeError(const char * what_arg)

public const char *what() const

public virtual~HandshakeError() = default



class HP::Omnicept::Abi::HeartRate

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

Domain type for heart rate data.

Summary

Members Descriptions
public uint32_trate Heart beats per minute. Zero value indicates sensor signal quality is too poor to calculate.
publicHeartRate()
public virtual~HeartRate()
public booloperator==(constHeartRate& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const


Members

public uint32_trate

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

publicHeartRate()

public virtual~HeartRate()

public booloperator==(constHeartRate& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::HeartRateFrame

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

Domain type for HeartRate Frames.

Summary

Members Descriptions
publicHeartRateFrame()
public virtual~HeartRateFrame() = default


Members

publicHeartRateFrame()

public virtual~HeartRateFrame() = default



class HP::Omnicept::Abi::HeartRateVariability

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

Domain type for heart rate variability data.

Summary

Members Descriptions
public floatsdnn Standard deviation between two normal heart beats in milliseconds. Zero value indicates sensor signal quality is too poor to calculate.
public floatrmssd Root-mean square of successive differences in milliseconds. Zero value indicates sensor signal quality is too poor to calculate.
publicHeartRateVariability()
public virtual~HeartRateVariability()
public booloperator==(constHeartRateVariability& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const


Members

public floatsdnn

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

public floatrmssd

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

publicHeartRateVariability()

public virtual~HeartRateVariability()

public booloperator==(constHeartRateVariability& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::IMessage

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

Summary

Members Descriptions
public virtual~IMessage() = default
publicMessageTypegetMessageType() const Gets the message type, indicating what the payload is.
public voidsetSender(std::string) Sets the sender, where the message originated from.
public std::stringgetSender() 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 voidsetDestination(const std::string) Sets the destination, where the message should be sent. If empty will send to all connections.
public std::stringgetDestination() const Gets the destination, where the message is to be sent to.
public uint64_tgetHeaderByteLength() const Gets the length of the header, in bytes.
public uint64_tgetBodyByteLength() const Gets the length of the body, in bytes.
public constSensorInfo&getSensorInfo() const Get the associate sensorInfo for this message.
public uint64_tserializeHeaderToByteArray(uint8_t * destination,uint64_t maxLength) Writes the header (PackageDeclaration) into a byte array.
public uint64_tserializeBodyToByteArray(uint8_t * destination,uint64_t maxLength) Writes the body into a byte array.
public template<>
inline boolisMessageA() const
Checks if an IMessage is a serialized DomainType message.


Members

public virtual~IMessage() = default

publicMessageTypegetMessageType() const

Gets the message type, indicating what the payload is.

public voidsetSender(std::string)

Sets the sender, where the message originated from.

public std::stringgetSender() 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 voidsetDestination(const std::string)

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

public std::stringgetDestination() const

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

public uint64_tgetHeaderByteLength() const

Gets the length of the header, in bytes.

public uint64_tgetBodyByteLength() const

Gets the length of the body, in bytes.

public constSensorInfo&getSensorInfo() const

Get the associate sensorInfo for this message.

public uint64_tserializeHeaderToByteArray(uint8_t * destination,uint64_t maxLength)

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_tserializeBodyToByteArray(uint8_t * destination,uint64_t maxLength)

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 boolisMessageA() const

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

Summary

Members Descriptions
public floatx
public floaty
public floatz
publicIMU3AxisValues()
publicIMU3AxisValues(float x,float y,float z)
public virtual~IMU3AxisValues() = default
public booloperator==(constIMU3AxisValues& other) const
public std::stringtoString() const


Members

public floatx

public floaty

public floatz

publicIMU3AxisValues()

publicIMU3AxisValues(float x,float y,float z)

public virtual~IMU3AxisValues() = default

public booloperator==(constIMU3AxisValues& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::IMU

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
publicIMU3AxisValuesacc Accelerometer IMU3AxisValues.
publicIMU3AxisValuesgyro Gyro IMU3AxisValues.
publicIMU()
publicIMU(IMU3AxisValuesaccValues,IMU3AxisValuesgyroValues)
public virtual~IMU() = default
public booloperator==(constIMU& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const


Members

publicIMU3AxisValuesacc

Accelerometer IMU3AxisValues.

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

publicIMU3AxisValuesgyro

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

publicIMU()

publicIMU(IMU3AxisValuesaccValues,IMU3AxisValuesgyroValues)

public virtual~IMU() = default

public booloperator==(constIMU& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::IMUFrame

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
publicIMUFrame()
public virtual~IMUFrame() = default


Members

publicIMUFrame()

public virtual~IMUFrame() = default



class HP::Omnicept::Abi::MessageTypeUtils

Summary

Members Descriptions


Members



class HP::Omnicept::Abi::ModuleControlSignal

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
publicModuleControlSignal()
publicModuleControlSignal(ModuleControlSignalTypesignal)
public~ModuleControlSignal() = default
public voidSetSignal(ModuleControlSignalTypesignal)
public constModuleControlSignalTypeGetSignal() const
public booloperator==(constModuleControlSignal& other) const


Members

publicModuleControlSignal()

publicModuleControlSignal(ModuleControlSignalTypesignal)

public~ModuleControlSignal() = default

public voidSetSignal(ModuleControlSignalTypesignal)

public constModuleControlSignalTypeGetSignal() const

public booloperator==(constModuleControlSignal& other) const



class HP::Omnicept::Abi::PPG

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
publicPPG()
publicPPG(const std::vector< uint32_t > & values)
public virtual~PPG() = default
public booloperator==(constPPG& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const


Members

public std::vector< uint32_t >ledValues

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.

publicPPG()

publicPPG(const std::vector< uint32_t > & values)

public virtual~PPG() = default

public booloperator==(constPPG& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::PPGFrame

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.
publicPPGFrame()
publicPPGFrame(std::vector< uint32_t > & ledCurrents)
public virtual~PPGFrame() = default
public std::stringtoString() const


Members

public std::vector< uint32_t >ledCurrents

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.

publicPPGFrame()

publicPPGFrame(std::vector< uint32_t > & ledCurrents)

public virtual~PPGFrame() = default

public std::stringtoString() const



class HP::Omnicept::Abi::ProtocolError

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 explicitProtocolError(const std::string & what_arg)
public explicitProtocolError(const char * what_arg)
public virtual~ProtocolError() = default


Members

public explicitProtocolError(const std::string & what_arg)

public explicitProtocolError(const char * what_arg)

public virtual~ProtocolError() = default



class HP::Omnicept::Abi::EyeSceneColors

Domain type for eye average color and brightness.

Contains the ambient and foveal average color a single Eye

Summary

Members Descriptions
publicColorambientColor Ambient color is average color calculated over the entire image.
publicColorfovealColor Foveal color is average color calculated over the foveal region of the eye.
publicEyeSceneColors()
publicEyeSceneColors(constColor& ambient,constColor& foveal)
public virtual~EyeSceneColors() = default
public booloperator==(constEyeSceneColors& other) const
public std::stringtoString() const


Members

publicColorambientColor

Ambient color is average color calculated over the entire image.

publicColorfovealColor

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

publicEyeSceneColors()

publicEyeSceneColors(constColor& ambient,constColor& foveal)

public virtual~EyeSceneColors() = default

public booloperator==(constEyeSceneColors& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::SceneColor

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
publicEyeSceneColorsleftEyeSceneColors EyeSceneColors for left display.
publicEyeSceneColorsrightEyeSceneColors EyeSceneColors for right display.
publicSceneColor()
publicSceneColor(constEyeSceneColors& left,constEyeSceneColors& right)
public virtual~SceneColor() = default
public booloperator==(constSceneColor& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const


Members

publicEyeSceneColorsleftEyeSceneColors

EyeSceneColors for left display.

publicEyeSceneColorsrightEyeSceneColors

EyeSceneColors for right display.

publicSceneColor()

publicSceneColor(constEyeSceneColors& left,constEyeSceneColors& right)

public virtual~SceneColor() = default

public booloperator==(constSceneColor& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const



class HP::Omnicept::Abi::SceneColorFrame

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
publicSceneColorFrame()
public virtual~SceneColorFrame() = default


Members

publicSceneColorFrame()

public virtual~SceneColorFrame() = default



class HP::Omnicept::Abi::SensorDeviceId

Uniquely identifies a sensor.

Summary

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


Members

public std::stringid

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

public std::stringsubId

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

publicSensorDeviceId() = default

publicSensorDeviceId(constSensorDeviceId&) = default

publicSensorDeviceId(SensorDeviceId&&) = default

publicSensorDeviceId&operator=(constSensorDeviceId&) = default

publicSensorDeviceId&operator=(SensorDeviceId&&) = default

publicSensorDeviceId(const std::string & id,const std::string & subId)

public virtual~SensorDeviceId() = default

public booloperator==(constSensorDeviceId& other) const

public booloperator<(constSensorDeviceId& rhs) const



class HP::Omnicept::Abi::SensorInfo

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

Summary

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


Members

publicSensorDeviceIddeviceId

the sensor's unique identifier

public std::stringlocation

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

publicSensorInfo()

publicSensorInfo(constSensorDeviceId& deviceId,const std::string & location)

publicSensorInfo(constSensorInfo&) = default

publicSensorInfo(SensorInfo&&) = default

publicSensorInfo&operator=(constSensorInfo&) = default

publicSensorInfo&operator=(SensorInfo&&) = default

publicSensorInfo(const std::string & id,const std::string & subid,const std::string & location)

public virtual~SensorInfo() = default

public booloperator==(constSensorInfo& other) const

public booloperator<(constSensorInfo& rhs) const



class HP::Omnicept::Abi::SerializationError

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 explicitSerializationError(const std::string & what_arg)
public explicitSerializationError(const char * what_arg)
public virtual~SerializationError() = default


Members

public explicitSerializationError(const std::string & what_arg)

public explicitSerializationError(const char * what_arg)

public virtual~SerializationError() = default



class HP::Omnicept::Abi::SessionLicense

Session license information.

Summary

Members Descriptions
publicSessionLicense(std::string clientId,std::string accessKey,LicensingModelrequestedLicense,bool isRunningInEditor) Used to store session license information.
public booloperator==(constSessionLicense& other) const
public const std::string &getClientId() const
public const std::string &getAccessKey() const
publicAbi::LicensingModelgetRequestedLicense() const
public boolgetIsRunningInEditor() const


Members

publicSessionLicense(std::string clientId,std::string accessKey,LicensingModelrequestedLicense,bool isRunningInEditor)

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 booloperator==(constSessionLicense& other) const

public const std::string &getClientId() const

public const std::string &getAccessKey() const

publicAbi::LicensingModelgetRequestedLicense() const

public boolgetIsRunningInEditor() const



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.

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
publicSubscription()
publicSubscription(MessageTypemessageType,constSensorInfo& sensorInfo,const std::string & sender)
publicSubscription(uint32_t messageType,constSensorInfo& sensorInfo,const std::string & sender)
public virtual~Subscription()
public constMessageType&getType() const
public constSensorInfo&getSensorInfo() const
public const std::string &getSender() const
public voidsetType(constMessageType& type)
public voidsetSensorInfo(constSensorInfo& sensorInfo)
public voidsetSender(const std::string & sender)
public booloperator==(constSubscription& other) const


Members

publicSubscription()

publicSubscription(MessageTypemessageType,constSensorInfo& sensorInfo,const std::string & sender)

publicSubscription(uint32_t messageType,constSensorInfo& sensorInfo,const std::string & sender)

public virtual~Subscription()

public constMessageType&getType() const

public constSensorInfo&getSensorInfo() const

public const std::string &getSender() const

public voidsetType(constMessageType& type)

public voidsetSensorInfo(constSensorInfo& sensorInfo)

public voidsetSender(const std::string & sender)

public booloperator==(constSubscription& other) const



class HP::Omnicept::Abi::SubscriptionList

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
publicSubscriptionList() = 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 voidsetSubscriptions(const std::vector<Subscription> & subscriptions)
public booloperator==(constSubscriptionList& other) const


Members

publicSubscriptionList() = 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 voidsetSubscriptions(const std::vector<Subscription> & subscriptions)

public booloperator==(constSubscriptionList& other) const



class HP::Omnicept::Abi::Timestamp

Specifies the timestamp collection.

Summary

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


Members

public int64_tsystemTimeMicroSeconds

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

public int64_thardwareTimeMicroSeconds

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

public int64_tomniceptTimeMicroSeconds

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

publicTimestamp()

public virtual~Timestamp() = default

public booloperator==(constTimestamp& other) const



class HP::Omnicept::Abi::TimestampCalculator

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

Summary

Members Descriptions
public std::deque<PacketTimeInfo>packetTimeInfoQueue
publicTimestampCalculator(double expectedSensorFrequency,size_t maxQueueSize)
public virtual~TimestampCalculator() = default
public voidaddPacketTimeInfo(PacketTimeInfotimeInfo)
publicNextTimestampResultgetNextTimestamp()
public voidnotifyDeviceReset()
public doublecalculateSkew()


Members

public std::deque<PacketTimeInfo>packetTimeInfoQueue

publicTimestampCalculator(double expectedSensorFrequency,size_t maxQueueSize)

public virtual~TimestampCalculator() = default

public voidaddPacketTimeInfo(PacketTimeInfotimeInfo)

publicNextTimestampResultgetNextTimestamp()

public voidnotifyDeviceReset()

public doublecalculateSkew()



class HP::Omnicept::Abi::TransportError

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 explicitTransportError(const std::string & what_arg)
public explicitTransportError(const char * what_arg)
public virtual~TransportError() = default


Members

public explicitTransportError(const std::string & what_arg)

public explicitTransportError(const char * what_arg)

public virtual~TransportError() = default



class HP::Omnicept::Abi::VSync

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

Domain type for time facial camera shutter is open.

Summary

Members Descriptions
publicVSync()
public virtual~VSync() = default
public booloperator==(constVSync& other) const
public virtual booldataEquals(constDomainData& other) const
public std::stringtoString() const


Members

publicVSync()

public virtual~VSync() = default

public booloperator==(constVSync& other) const

public virtual booldataEquals(constDomainData& other) const

public std::stringtoString() const



struct HP::Omnicept::Abi::EyeGaze

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 floatx
public floaty
public floatz
publicEyeGaze()
publicEyeGaze(float x,float y,float z)
public booloperator==(constEyeGaze& other) const
public std::stringtoString() const


Members

public floatx

public floaty

public floatz

publicEyeGaze()

publicEyeGaze(float x,float y,float z)

public booloperator==(constEyeGaze& other) const

public std::stringtoString() const



struct HP::Omnicept::Abi::PupilPosition

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 floatx
public floaty
publicPupilPosition()
publicPupilPosition(float x,float y)
public booloperator==(constPupilPosition& other) const
public std::stringtoString() const


Members

public floatx

public floaty

publicPupilPosition()

publicPupilPosition(float x,float y)

public booloperator==(constPupilPosition& other) const

public std::stringtoString() const



struct HP::Omnicept::Abi::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 floatr Red [0.f,1.f].
public floatg Green [0.f,1.f].
public floatb Blue [0.f,1.f].
public floaty Luminance [0.f,1.f].
publicColor()
publicColor(float r,float g,float b,float y)
public virtual~Color() = default
public booloperator==(constColor& other) const
public std::stringtoString() const


Members

public floatr

Red [0.f,1.f].

public floatg

Green [0.f,1.f].

public floatb

Blue [0.f,1.f].

public floaty

Luminance [0.f,1.f].

publicColor()

publicColor(float r,float g,float b,float y)

public virtual~Color() = default

public booloperator==(constColor& other) const

public std::stringtoString() const



namespace HP::Omnicept::Utils

Summary

Members Descriptions
classHP::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.
structHP::Omnicept::Utils::IUuid
structHP::Omnicept::Utils::FileSystem



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.

Summary

Members Descriptions
public virtual~ThreadOwner()
public virtual voidstart() Start the thread inside this object. Idempotent.
public virtual voidrequestStop() Ask that this thread stops when it is convenient, asynchronously.
public virtual booljoin() Joins the thread the thread whenever it completes, does not request a stop.
public virtual boolshouldContinue() const Checks if the Thread should continue or not.
public std::thread::idgetThreadId() const Gets the thread id of this object's thread.


Members

public virtual~ThreadOwner()

public virtual voidstart()

Start the thread inside this object. Idempotent.

public virtual voidrequestStop()

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

public virtual booljoin()

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 boolshouldContinue() const

Checks if the Thread should continue or not.

public std::thread::idgetThreadId() const

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

Summary

Members Descriptions
publicIUuid() = default
public virtual~IUuid() = default
publicoperator std::string() const


Members

publicIUuid() = default

public virtual~IUuid() = default

publicoperator std::string() const



struct HP::Omnicept::Utils::FileSystem

Summary

Members Descriptions


Members



class HP::Omnicept::Glia::AsyncClientBuilder

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

Summary

Members Descriptions
public boolisClientBuildFinished() const Can the Client be built without blocking.
public boolisValid() const Is the AsyncClientBuilder valid.
public voidwaitForConnection() 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.
publicAsyncClientBuilder(constAsyncClientBuilder&) = delete
publicAsyncClientBuilder&operator=(constAsyncClientBuilder&) = delete
publicAsyncClientBuilder(AsyncClientBuilder&&) = default
publicAsyncClientBuilder&operator=(AsyncClientBuilder&&) = default


Members

public boolisClientBuildFinished() const

Can the Client be built without blocking.

Returns

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

public boolisValid() const

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 voidwaitForConnection()

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()

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

Destructor for AsyncClientBuilder.

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

publicAsyncClientBuilder(constAsyncClientBuilder&) = delete

publicAsyncClientBuilder&operator=(constAsyncClientBuilder&) = delete

publicAsyncClientBuilder(AsyncClientBuilder&&) = default

publicAsyncClientBuilder&operator=(AsyncClientBuilder&&) = default



class ClientBuildHelpers

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

Summary

Members Descriptions
public inlineSemaphore()
public inline explicitSemaphore(size_t count)
public virtual~Semaphore() = default
public inline voidnotify(size_t count)
public inline voidwait()


Members

public inlineSemaphore()

public inline explicitSemaphore(size_t count)

public virtual~Semaphore() = default

public inline voidnotify(size_t count)

public inline voidwait()



class SessionLicenseHelper

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

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::stringerrorMsg 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

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

public std::stringerrorMsg

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 representing the result of Client::getLastData()

Parameters

  • DomainType the type of data

Summary

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


Members

public DomainTypedata

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

public boolvalid

if data is valid.



struct HP::Omnicept::Abi::TimestampCalculator::NextTimestampResult

Summary

Members Descriptions
public int64_thwInterpolatedTime
public int64_tomniceptTime


Members

public int64_thwInterpolatedTime

public int64_tomniceptTime



struct HP::Omnicept::Abi::TimestampCalculator::PacketTimeInfo

Summary

Members Descriptions
public int64_thwTime
public int64_tsysTime
public uint8_tnumSamples
public int64_tsysDiff
public int64_thwDiff
public doubleinstantSkew
public inlinePacketTimeInfo(int64_t hw,int64_t sys,uint8_t num,int64_t sysD,int64_t hwD,double iSkew)


Members

public int64_thwTime

public int64_tsysTime

public uint8_tnumSamples

public int64_tsysDiff

public int64_thwDiff

public doubleinstantSkew

public inlinePacketTimeInfo(int64_t hw,int64_t sys,uint8_t num,int64_t sysD,int64_t hwD,double iSkew)