#include <rs_frame.hpp>

Inheritance diagram for rs2::stream_profile:

Public Member Functions
template<class T >
T	as () const

stream_profile	clone (rs2_stream type, int index, rs2_format format) const

rs2_format	format () const

int	fps () const

const rs2_stream_profile *	get () const

rs2_extrinsics	get_extrinsics_to (const stream_profile &to) const

template<class T >
bool	is () const

bool	is_cloned ()

bool	is_default () const

	operator bool () const

	operator const rs2_stream_profile * ()

	operator std::shared_ptr< rs2_stream_profile > ()

bool	operator== (const stream_profile &rhs)

void	register_extrinsics_to (const stream_profile &to, rs2_extrinsics extrinsics)

int	stream_index () const

std::string	stream_name () const

	stream_profile ()

	stream_profile (const rs2_stream_profile *profile)

rs2_stream	stream_type () const

int	unique_id () const

Protected Attributes
std::shared_ptr< rs2_stream_profile >	_clone

bool	_default = false

rs2_format	_format = RS2_FORMAT_ANY

int	_framerate = 0

int	_index = 0

const rs2_stream_profile *	_profile

rs2_stream	_type = RS2_STREAM_ANY

int	_uid = 0

Friends
class	rs2::frame

class	rs2::pipeline_profile

class	rs2::sensor

class	rs2::video_stream_profile

Detailed Description

Definition at line 22 of file rs_frame.hpp.

Constructor & Destructor Documentation

rs2::stream_profile::stream_profile ( )

inline

Class to store the profile of stream

Definition at line 28 of file rs_frame.hpp.

rs2::stream_profile::stream_profile ( const rs2_stream_profile * profile )

inlineexplicit

Definition at line 170 of file rs_frame.hpp.

Member Function Documentation

template<class T >

T rs2::stream_profile::as ( ) const

inline

Template function, casting the instance as another class type

Returns: class instance - pointer or null.

Definition at line 103 of file rs_frame.hpp.

stream_profile rs2::stream_profile::clone	(	rs2_stream	type,
		int	index,
		rs2_format	format
	)		const

inline

Clone the current profile and change the type, index and format to input parameters

Parameters

[in]	type	- will change the stream type from the cloned profile.
[in]	index	- will change the stream index from the cloned profile.
[in]	format	- will change the stream format from the cloned profile.

Returns: stream_profile - return the cloned stream profile.

Definition at line 63 of file rs_frame.hpp.

rs2_format rs2::stream_profile::format ( ) const

inline

Return the stream format

Returns: rs2_format - stream format

Definition at line 44 of file rs_frame.hpp.

int rs2::stream_profile::fps ( ) const

inline

Return the stream frame per second

Returns: int - frame rate

Definition at line 49 of file rs_frame.hpp.

const rs2_stream_profile* rs2::stream_profile::get ( ) const

inline

Get back the internal stream profile instance

Returns: rs2_stream_profile* - internal implementation of the profile class

Definition at line 137 of file rs_frame.hpp.

rs2_extrinsics rs2::stream_profile::get_extrinsics_to ( const stream_profile & to ) const

inline

Operator implement, return the internal stream profile instance.

Returns: rs2_stream_profile* - internal instance to communicate with real implementation. Get the extrinsic transformation between two profiles (representing physical sensors)

Parameters

[in] stream_profile to - the stream profile (another sensor) to be based to return the extrinsic

Returns: rs2_stream_profile* - internal instance to communicate with real implementation.

Definition at line 148 of file rs_frame.hpp.

template<class T >

bool rs2::stream_profile::is ( ) const

inline

Template function, checking if the instance belongs to specific class type

Returns: bool - true or false.

Definition at line 92 of file rs_frame.hpp.

bool rs2::stream_profile::is_cloned ( )

inline

Definition at line 169 of file rs_frame.hpp.

bool rs2::stream_profile::is_default ( ) const

inline

Checks if stream profile is marked/assigned as default, meaning that the profile will be selected when the user requests stream configuration using wildcards (RS2_DEPTH, -1,-1,...

Returns: bool - true or false.

Definition at line 125 of file rs_frame.hpp.

rs2::stream_profile::operator bool ( ) const

inline

Checks if the profile is valid

Returns: bool - true or false.

Definition at line 131 of file rs_frame.hpp.

rs2::stream_profile::operator const rs2_stream_profile * ( )

inline

Definition at line 180 of file rs_frame.hpp.

rs2::stream_profile::operator std::shared_ptr< rs2_stream_profile > ( )

inlineexplicit

Definition at line 181 of file rs_frame.hpp.

bool rs2::stream_profile::operator== ( const stream_profile & rhs )

inline

Comparison operator, compare if two stream profiles are the same

Parameters

[in] rhs - stream profile to compare with.

Returns: bool - true or false.

Definition at line 79 of file rs_frame.hpp.

void rs2::stream_profile::register_extrinsics_to	(	const stream_profile &	to,
		rs2_extrinsics	extrinsics
	)

inline

Assign extrinsic transformation parameters to a specific profile (sensor). The extrinsic information is generally available as part of the camera calibration, and librealsense is responsible for retrieving and assigning these parameters where appropriate. This specific function is intended for synthetic/mock-up (software) devices for which the parameters are produced and injected by the user.

Parameters

[in]	stream_profile	to - which stream profile to be registered with the extrinsic.
[in]	rs2_extrinsics	extrinsics - the extrinsics to be registered.

Definition at line 162 of file rs_frame.hpp.

int rs2::stream_profile::stream_index ( ) const

inline

Return the specific stream index

Returns: int - stream index

Definition at line 34 of file rs_frame.hpp.

std::string rs2::stream_profile::stream_name ( ) const

inline

Return the string of stream name

Returns: string - stream name.

Definition at line 113 of file rs_frame.hpp.

rs2_stream rs2::stream_profile::stream_type ( ) const

inline

Return the stream type

Returns: rs2_stream - stream type

Definition at line 39 of file rs_frame.hpp.

int rs2::stream_profile::unique_id ( ) const

inline

Return the assigned unique index when the stream was created

Returns: int - unique id

Definition at line 54 of file rs_frame.hpp.

Friends And Related Function Documentation

friend class rs2::frame

friend

Definition at line 185 of file rs_frame.hpp.

friend class rs2::pipeline_profile

friend

Definition at line 186 of file rs_frame.hpp.

friend class rs2::sensor

friend

Definition at line 184 of file rs_frame.hpp.

friend class rs2::video_stream_profile

friend

Definition at line 187 of file rs_frame.hpp.

Member Data Documentation

std::shared_ptr<rs2_stream_profile> rs2::stream_profile::_clone

protected

Definition at line 190 of file rs_frame.hpp.

bool rs2::stream_profile::_default = false

protected

Definition at line 198 of file rs_frame.hpp.

rs2_format rs2::stream_profile::_format = RS2_FORMAT_ANY

protected

Definition at line 195 of file rs_frame.hpp.

int rs2::stream_profile::_framerate = 0

protected

Definition at line 194 of file rs_frame.hpp.

int rs2::stream_profile::_index = 0

protected

Definition at line 192 of file rs_frame.hpp.

const rs2_stream_profile* rs2::stream_profile::_profile

protected

Definition at line 189 of file rs_frame.hpp.

rs2_stream rs2::stream_profile::_type = RS2_STREAM_ANY

protected

Definition at line 196 of file rs_frame.hpp.

int rs2::stream_profile::_uid = 0

protected

Definition at line 193 of file rs_frame.hpp.

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

rs_frame.hpp

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation