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 |
struct HP::Omnicept::Abi::TimestampCalculator::NextTimestampResult |
|
struct HP::Omnicept::Abi::TimestampCalculator::PacketTimeInfo |
namespace HP::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
Entry point in to the HP Omnicept SDK.
Summary
Members | Descriptions |
---|---|
public Glia () = delete |
Members
public
Glia
() = 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 () |
|
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
()
public
Result
startClient
()
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:
Result::SUCCESS if the Client's State successfully transitioned to State::RUNNING, or
Result::ERROR_CLIENT_DISCONNECTED if the Client's State is State::DISCONNECTED, or
Result::NO_OP_CLIENT_RUNNING if the Client's State is State::RUNNING
public
Result
pauseClient
()
If the Client's State is State::RUNNING changes the Client's State to State::PAUSED.
Returns
result which will be:
Result::SUCCESS if the Client's State successfully transitioned to State::PAUSED
Result::ERROR_CLIENT_DISCONNECTED if the Client's State is State::DISCONNECTED
Result::NO_OP_CLIENT_PAUSED if the Client's State is State::PAUSED,
public
Result
disconnectClient
()
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:
Result::SUCCESS if the Client's State successfully transitioned to State::DISCONNECTED
Result::ERROR_CLIENT_DISCONNECTED if the Client's State was already 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.
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:
Result::ERROR_CLIENT_DISCONNECTED if the Client's State is State::DISCONNECTED
Result::UNSPECIFIED_ERROR if
callback
is a nullptrResult::SUCCESS otherwise
public template<>
inline
Result
unregisterCallback
()
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:
Result::ERROR_CLIENT_DISCONNECTED if the Client's State is State::DISCONNECTED
Result::SUCCESS otherwise
public template<>
inline bool
isCallbackRegisteredForType
()
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
()
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
DomainType
the domain type of the message (e.g. Abi::HeartRate)
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)
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:
Result::ERROR_CLIENT_DISCONNECTED if the Client's State is State::DISCONNECTED
Result::NO_OP_CLIENT_PAUSED if the Client's State is State::PAUSED
Result::UNSPECIFIED_ERROR if
dvrCallback
is a nullptrResult::SUCCESS otherwise
public
Result
stopDataRecord
()
Stop recording all DomainType messages data send to HP Omnicept Runtime.
Returns
result which will be:
Result::ERROR_CLIENT_DISCONNECTED if the Client's State is State::DISCONNECTED
Result::NO_OP_CLIENT_PAUSED if the Client's State is State::PAUSED
Result::SUCCESS otherwise
public
State
getClientState
() const
Gets the current State of the Client.
Returns
the Client's State
public
Result
setSubscriptions
(const
Abi::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:
Result::ERROR_CLIENT_DISCONNECTED if the Client's State is State::DISCONNECTED
Result::SUCCESS otherwise
enum
State
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
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
namespace HP::Omnicept::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
Values | Descriptions |
---|---|
UNKNOWN | |
EYE_TRACKING | |
EYE_TRACKING_PPG |
enum
ConfigurationErrorCode_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 |
enum
DataVaultResultType
Values | Descriptions |
---|---|
UNKNOWN | |
RECORDING_STARTED | |
RECORDING_START_REJECTED | |
RECORDING_STOPPED | |
RECORDING_STOP_REJECTED | |
RECORDING_ERROR |
enum
DataVaultResultErrorType
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
Values | Descriptions |
---|---|
unknown | |
left | |
right | |
both |
enum
LicensingModel
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
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
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
&)
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
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
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
class HP::Omnicept::Abi::BackpackColors
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
()
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
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 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
public bool
isPresent
public float
percent
public
Battery
()
public virtual
~Battery
()
public bool
operator==
(const
Battery
& other) const
public std::string
toString
() 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::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
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
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. |
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
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
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 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
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
class HP::Omnicept::Abi::NDimArrayFloat
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
public std::vector< float >
valuesFlat
public
NDimArrayFloat
() = default
public virtual
~NDimArrayFloat
() = default
public bool
operator==
(const
NDimArrayFloat
& other) const
public std::string
toString
() 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::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
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
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 |
---|---|
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
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
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 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)
public explicit
ConnectionError
(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 |
---|---|
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)
Constructs a ConnectionIdentifier.
Parameters
connectionName
the human readable name given by the incoming connectionuuid
the uuid assigned by the HP Omnicept Runtime as a string
Exceptions
std::invalid_argument
if theconnectionName
is empty or if theuuid
is invalid
public
ConnectionIdentifier
(const std::string identifier)
Constructs a ConnectionIdentifier.
Parameters
identifier
a stringified ConnectionIdentifier
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)
Constructs a ConnectionIdentifier.
Parameters
connectionName
the human readable name given by the incoming connectionuuid
the uuid assigned by the HP Omnicept Runtime
Exceptions
std::invalid_argument
if theconnectionName
is empty, or if theuuid
is invalid
public std::string
getConnectionName
() const
Gets the ConnectionIdentifier's connection name.
Returns
the ConnectionIdentifier's connection name
public std::string
getUuid
() const
Gets the ConnectionIdentifier's uuid as a string.
Returns
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
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
T
the type for this DataFrame collection.
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
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
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 |
---|---|
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
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
class HP::Omnicept::Abi::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
Create Dependency.
public explicit
Dependency
(std::map< std::string, std::string > initial)
Create Dependency from map.
Parameters
initial
a map
public explicit
Dependency
(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 bool
has
(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_t
size
() const noexcept
Retrieve number of attributes.
Returns
number of attributes
public void
add
(const std::string & key,const std::string & value)
Adds specified attribute.
Parameters
key
name of the attributevalue
value of the attribute
public void
remove
(const std::string & key)
Removes specified attribute.
Parameters
key
name of the attribute
public bool
operator==
(const
Dependency
& other) const
public bool
operator!=
(const
Dependency
& other) const
class HP::Omnicept::Abi::DependencyList
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
public explicit
DependencyList
(std::vector<
Dependency
>)
public virtual
~DependencyList
() = default
public bool
has
(const
Dependency
& dependency) const
Checks if dependency exist.
Parameters
dependency
dependency to check
Returns
true if exist, else false
public std::size_t
size
() const noexcept
Retrieve number of attributes.
Returns
number of attributes
public void
add
(const
Dependency
& dependency)
Adds specified dependency.
Parameters
dependency
the dependency to add
public void
remove
(const
Dependency
& dependency)
Removes specified dependency.
Parameters
dependency
the dependency to remove
public bool
operator==
(const
DependencyList
& other) const
public bool
operator!=
(const
DependencyList
& 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 |
---|---|
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
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
class HP::Omnicept::Abi::EyePupilDiameter
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
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
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 |
---|---|
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
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
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 |
---|---|
public EyePupillometryFrame () |
|
public virtual ~EyePupillometryFrame () = default |
Members
public
EyePupillometryFrame
()
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 |
---|---|
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
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
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 |
---|---|
public EyeTrackingFrame () |
|
public virtual ~EyeTrackingFrame () = default |
Members
public
EyeTrackingFrame
()
public virtual
~EyeTrackingFrame
() = default
class HP::Omnicept::Abi::GenericMessage
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
public
GenericMessage
(
MessageType
msgType)
public virtual
~GenericMessage
() = default
public
MessageType
getMessageType
() const
public bool
operator==
(const
GenericMessage
& 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 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)
public explicit
HandshakeError
(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_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
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
class HP::Omnicept::Abi::HeartRateFrame
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
()
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 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
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
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 |
|
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
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.
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)
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
Checks if an IMessage is a serialized DomainType message.
Use instead of hardcoding a MessageType into a check
Parameters
DomainType
an Omnicept Message Type
Returns
true if msg
can be serialized to a DomainType, else false
class HP::Omnicept::Abi::IMU3AxisValues
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
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
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 |
---|---|
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
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
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
()
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
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 |
---|---|
public IMUFrame () |
|
public virtual ~IMUFrame () = default |
Members
public
IMUFrame
()
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 |
---|---|
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
()
public
ModuleControlSignal
(
ModuleControlSignalType
signal)
public
~ModuleControlSignal
() = default
public void
SetSignal
(
ModuleControlSignalType
signal)
public const
ModuleControlSignalType
GetSignal
() const
public bool
operator==
(const
ModuleControlSignal
& 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 |
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
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
()
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
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. |
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
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
()
public
PPGFrame
(std::vector< uint32_t > & ledCurrents)
public virtual
~PPGFrame
() = default
public std::string
toString
() 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 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)
public explicit
ProtocolError
(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 |
---|---|
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,const Color & foveal) |
|
public virtual ~EyeSceneColors () = default |
|
public bool operator== (const EyeSceneColors & other) const |
|
public std::string toString () const |
Members
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,const
Color
& foveal)
public virtual
~EyeSceneColors
() = default
public bool
operator==
(const
EyeSceneColors
& other) const
public std::string
toString
() 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 |
---|---|
public EyeSceneColors
leftEyeSceneColors |
EyeSceneColors for left display. |
public EyeSceneColors
rightEyeSceneColors |
EyeSceneColors for right display. |
public SceneColor () |
|
public SceneColor (const EyeSceneColors & left,const EyeSceneColors & 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
EyeSceneColors for left display.
public
EyeSceneColors
rightEyeSceneColors
EyeSceneColors for right display.
public
SceneColor
()
public
SceneColor
(const
EyeSceneColors
& left,const
EyeSceneColors
& 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
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 |
---|---|
public SceneColorFrame () |
|
public virtual ~SceneColorFrame () = default |
Members
public
SceneColorFrame
()
public virtual
~SceneColorFrame
() = default
class HP::Omnicept::Abi::SensorDeviceId
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
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
class HP::Omnicept::Abi::SensorInfo
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
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
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 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)
public explicit
SerializationError
(const char * what_arg)
public virtual
~SerializationError
() = default
class HP::Omnicept::Abi::SessionLicense
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)
Used to store session license information.
Parameters
clientId
a unique string token as user identificationaccessKey
a unique string token tied to a user's applicationrequestedLicense
the type of licenseisRunningInEditor
only relevent whenrequestedLicense
is LicensingModel::ENTERPRISE. Should be set to true only if the license is being used for development.
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
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 |
---|---|
public Subscription () |
|
public Subscription ( MessageType messageType,const SensorInfo & 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
()
public
Subscription
(
MessageType
messageType,const
SensorInfo
& 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
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 |
---|---|
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
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
class HP::Omnicept::Abi::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
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
class HP::Omnicept::Abi::TimestampCalculator
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
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
()
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 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)
public explicit
TransportError
(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 |
---|---|
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
()
public virtual
~VSync
() = default
public bool
operator==
(const
VSync
& other) const
public virtual bool
dataEquals
(const
DomainData
& other) const
public std::string
toString
() 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 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
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
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 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
public float
y
public
PupilPosition
()
public
PupilPosition
(float x,float y)
public bool
operator==
(const
PupilPosition
& other) const
public std::string
toString
() 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 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
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
namespace HP::Omnicept::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
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
()
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.
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
Checks if the Thread should continue or not.
public std::thread::id
getThreadId
() 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 |
---|---|
public IUuid () = default |
|
public virtual ~IUuid () = default |
|
public operator std::string () const |
Members
public
IUuid
() = default
public virtual
~IUuid
() = default
public
operator 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 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
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
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
()
Waits for the asynchronous thread building a connection to the HP Omnicept Runtime to finish.
Upon returning, isClientBuildFinished will return true
Exceptions
std::logic_error
if the AsyncClientBuilder is no longer valid. Can check with AsyncClientBuilder::isValid()
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 Runtimestd::invalid_argument
if invalid parameters were passed to the Client see exceptions listed in Client::Client for detailsstd::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.
public
AsyncClientBuilder
(const
AsyncClientBuilder
&) = delete
public
AsyncClientBuilder
&
operator=
(const
AsyncClientBuilder
&) = delete
public
AsyncClientBuilder
(
AsyncClientBuilder
&&) = default
public
AsyncClientBuilder
&
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 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
()
public inline explicit
Semaphore
(size_t count)
public virtual
~Semaphore
() = default
public inline void
notify
(size_t count)
public inline void
wait
()
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::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
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.
struct HP::Omnicept::Client::LastValueCached
struct representing the result of Client::getLastData
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
data stored in Client's lvc if valid is true, otherwise the default value of DomainType
public bool
valid
if data is valid.
struct HP::Omnicept::Abi::TimestampCalculator::NextTimestampResult
Summary
Members | Descriptions |
---|---|
public int64_t hwInterpolatedTime |
|
public int64_t omniceptTime |
Members
public int64_t
hwInterpolatedTime
public int64_t
omniceptTime
struct HP::Omnicept::Abi::TimestampCalculator::PacketTimeInfo
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) |