ob::GyroFrame Class Reference

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

#include <Frame.hpp>

Inheritance diagram for ob::GyroFrame:

Public Member Functions
	GyroFrame (Frame &frame)
	GyroFrame (std::unique_ptr< FrameImpl > impl)
	~GyroFrame () noexcept override=default
OBGyroValue	value ()
	Get the gyro frame data.
float	temperature ()
	Get the temperature when the frame was sampled.
Public Member Functions inherited from ob::Frame
	Frame (std::unique_ptr< FrameImpl > impl)
	Frame (Frame &frame)
virtual	~Frame () noexcept
virtual OBFrameType	type ()
	Get the type of frame.
virtual OBFormat	format ()
	Get the format of the frame.
virtual uint64_t	index ()
	Get the sequence number of the frame.
virtual void *	data ()
	Get the frame data.
virtual uint32_t	dataSize ()
	Get the size of the frame data.
uint64_t	timeStamp ()
	Get the hardware timestamp of the frame in milliseconds.
uint64_t	timeStampUs ()
	Get the hardware timestamp of the frame in microseconds.
uint64_t	systemTimeStamp ()
	Get the system timestamp of the frame in milliseconds.
uint64_t	systemTimeStampUs ()
	Get the system timestamp of the frame in microseconds.
uint64_t	globalTimeStampUs ()
	Get the global timestamp of the frame in microseconds.
void *	metadata ()
	Get the metadata of the frame.
uint32_t	metadataSize ()
	Get the size of the metadata of the frame.
bool	hasMetadata (OBFrameMetadataType type)
	Check if the frame object has metadata of a given type.
int64_t	getMetadataValue (OBFrameMetadataType type)
	Get the metadata value.
std::shared_ptr< StreamProfile >	getStreamProfile ()
	get StreamProfile of the frame
std::shared_ptr< Sensor >	getSensor ()
	get owner sensor of the frame
std::shared_ptr< Device >	getDevice ()
	get owner device of the frame
template<typename T >
bool	is ()
	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.

Additional Inherited Members
Protected Attributes inherited from ob::Frame
std::unique_ptr< FrameImpl >	impl_

Detailed Description

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

Definition at line 400 of file Frame.hpp.

Constructor & Destructor Documentation

GyroFrame() [1/2]

ob::GyroFrame::GyroFrame ( Frame &  frame )

explicit

GyroFrame() [2/2]

ob::GyroFrame::GyroFrame ( std::unique_ptr< FrameImpl >  impl )

explicit

~GyroFrame()

ob::GyroFrame::~GyroFrame ( )

overridedefaultnoexcept

Member Function Documentation

value()

OBGyroValue ob::GyroFrame::value

(

)

Get the gyro frame data.

Returns

OBAccelValue The gyro frame data

temperature()

float ob::GyroFrame::temperature

(

)

Get the temperature when the frame was sampled.

Returns

float The temperature value

---

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

• E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/Frame.hpp