Public Member Functions | Private Attributes | Friends | List of all members
rs2::pipeline_profile Class Reference

#include <rs_pipeline.hpp>

Public Member Functions

device get_device () const
stream_profile get_stream (rs2_stream stream_type, int stream_index=-1) const
std::vector< stream_profileget_streams () const
 operator bool () const
 operator std::shared_ptr< rs2_pipeline_profile > ()
 pipeline_profile ()
 pipeline_profile (std::shared_ptr< rs2_pipeline_profile > profile)

Private Attributes

std::shared_ptr< rs2_pipeline_profile_pipeline_profile


class config
class pipeline

Detailed Description

The pipeline profile includes a device and a selection of active streams, with specific profiles. The profile is a selection of the above under filters and conditions defined by the pipeline. Streams may belong to more than one sensor of the device.

Definition at line 18 of file rs_pipeline.hpp.

Constructor & Destructor Documentation

rs2::pipeline_profile::pipeline_profile ( )

Definition at line 22 of file rs_pipeline.hpp.

rs2::pipeline_profile::pipeline_profile ( std::shared_ptr< rs2_pipeline_profile profile)

Definition at line 106 of file rs_pipeline.hpp.

Member Function Documentation

device rs2::pipeline_profile::get_device ( ) const

Retrieve the device used by the pipeline. The device class provides the application access to control camera additional settings - get device information, sensor options information, options value query and set, sensor specific extensions. Since the pipeline controls the device streams configuration, activation state and frames reading, calling the device API functions, which execute those operations, results in unexpected behavior. The pipeline streaming device is selected during pipeline start(). Devices of profiles, which are not returned by pipeline start() or get_active_profile(), are not guaranteed to be used by the pipeline.

rs2::device The pipeline selected device

Definition at line 83 of file rs_pipeline.hpp.

stream_profile rs2::pipeline_profile::get_stream ( rs2_stream  stream_type,
int  stream_index = -1 
) const

Return the stream profile that is enabled for the specified stream in this profile.

[in]stream_typeStream type of the desired profile
[in]stream_indexStream index of the desired profile. -1 for any matching.
The first matching stream profile

Definition at line 60 of file rs_pipeline.hpp.

std::vector<stream_profile> rs2::pipeline_profile::get_streams ( ) const

Return the selected streams profiles, which are enabled in this profile.

Vector of stream profiles

Definition at line 29 of file rs_pipeline.hpp.

rs2::pipeline_profile::operator bool ( ) const

Conversion to boolean value to test for the object's validity

true iff the profile is valid

Definition at line 100 of file rs_pipeline.hpp.

rs2::pipeline_profile::operator std::shared_ptr< rs2_pipeline_profile > ( )

Definition at line 105 of file rs_pipeline.hpp.

Friends And Related Function Documentation

friend class config

Definition at line 111 of file rs_pipeline.hpp.

friend class pipeline

Definition at line 112 of file rs_pipeline.hpp.

Member Data Documentation

std::shared_ptr<rs2_pipeline_profile> rs2::pipeline_profile::_pipeline_profile

Definition at line 110 of file rs_pipeline.hpp.

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

Author(s): Sergey Dorodnicov , Doron Hirshberg , Mark Horn , Reagan Lopez , Itay Carpis
autogenerated on Mon May 3 2021 02:50:41