ob::AccelFrame Class Reference

Define the AccelFrame class, which inherits from the Frame class. More...

#include <Frame.hpp>

Inheritance diagram for ob::AccelFrame:

Public Member Functions
	AccelFrame (const ob_frame *impl)
	~AccelFrame () noexcept override=default
OBAccelValue	getValue () const
	Get the accelerometer frame data.
float	getTemperature () const
	Get the temperature when the frame was sampled.
OBAccelValue	value ()
float	temperature ()
Public Member Functions inherited from ob::Frame
	Frame (const ob_frame *impl)
	Construct a new Frame object with a given pointer to the internal frame object.
const ob_frame *	getImpl () const
	Get the internal (impl) frame object.
virtual	~Frame () noexcept
	Destroy the Frame object.
virtual OBFrameType	getType () const
	Get the type of frame.
virtual OBFormat	getFormat () const
	Get the format of the frame.
virtual uint64_t	getIndex () const
	Get the sequence number of the frame.
virtual uint8_t *	getData () const
	Get frame data.
virtual uint32_t	getDataSize () const
	Get the size of the frame data.
uint64_t	getTimeStampUs () const
	Get the hardware timestamp of the frame in microseconds.
uint64_t	getSystemTimeStampUs () const
	Get the system timestamp of the frame in microseconds.
uint64_t	getGlobalTimeStampUs () const
	Get the global timestamp of the frame in microseconds.
uint8_t *	getMetadata () const
	Get the metadata pointer of the frame.
uint32_t	getMetadataSize () const
	Get the size of the metadata of the frame.
bool	hasMetadata (OBFrameMetadataType type) const
	Check if the frame object has metadata of a given type.
int64_t	getMetadataValue (OBFrameMetadataType type) const
	Get the metadata value.
std::shared_ptr< StreamProfile >	getStreamProfile () const
	get StreamProfile of the frame
std::shared_ptr< Sensor >	getSensor () const
	get owner sensor of the frame
std::shared_ptr< Device >	getDevice () const
	get owner device of the frame
template<typename T >
bool	is () const
	Check if the runtime type of the frame object is compatible with a given type.
template<typename T >
std::shared_ptr< T >	as ()
	Convert the frame object to a target type.
template<typename T >
std::shared_ptr< const T >	as () const
	Convert the frame object to a target type.
OBFrameType	type () const
virtual OBFormat	format () const
virtual uint64_t	index () const
virtual void *	data () const
virtual uint32_t	dataSize () const
uint64_t	timeStamp () const
uint64_t	timeStampUs () const
uint64_t	systemTimeStamp () const
uint64_t	systemTimeStampUs () const
uint64_t	globalTimeStampUs () const
uint8_t *	metadata () const
uint32_t	metadataSize () const

Additional Inherited Members
Protected Attributes inherited from ob::Frame
const ob_frame *	impl_ = nullptr
	The pointer to the internal (c api level) frame object.

Detailed Description

Define the AccelFrame class, which inherits from the Frame class.

Definition at line 605 of file Frame.hpp.

Constructor & Destructor Documentation

AccelFrame()

ob::AccelFrame::AccelFrame ( const ob_frame * impl )

inlineexplicit

Definition at line 608 of file Frame.hpp.

~AccelFrame()

ob::AccelFrame::~AccelFrame ( )

overridedefaultnoexcept

Member Function Documentation

getValue()

OBAccelValue ob::AccelFrame::getValue ( ) const

inline

Get the accelerometer frame data.

Returns

OBAccelValue The accelerometer frame data

Definition at line 617 of file Frame.hpp.

getTemperature()

float ob::AccelFrame::getTemperature ( ) const

inline

Get the temperature when the frame was sampled.

Returns

float The temperature value in celsius

Definition at line 630 of file Frame.hpp.

value()

OBAccelValue ob::AccelFrame::value ( )

inline

Definition at line 640 of file Frame.hpp.

temperature()

float ob::AccelFrame::temperature ( )

inline

Definition at line 644 of file Frame.hpp.

---

The documentation for this class was generated from the following file:

• C:/Users/hzcyf/Projects/openorbbecsdkgroup/OpenOrbbecSDK/include/libobsensor/hpp/Frame.hpp