peak::core::DataStreamDescriptor Class Reference

Encapsulates the GenTL functions associated with a GenTL DataStream module's ID. More...

#include <peak/data_stream/peak_data_stream_descriptor.hpp>

Inheritance diagram for peak::core::DataStreamDescriptor:

Public Member Functions
	DataStreamDescriptor ()=delete
	~DataStreamDescriptor () override=default
	DataStreamDescriptor (const DataStreamDescriptor &other)=delete
DataStreamDescriptor &	operator= (const DataStreamDescriptor &other)=delete
	DataStreamDescriptor (DataStreamDescriptor &&other)=delete
DataStreamDescriptor &	operator= (DataStreamDescriptor &&other)=delete
std::string	Key () const
	Returns the unique key. More...
std::shared_ptr< Device >	ParentDevice () const
	Returns the parent device. More...
std::shared_ptr< DataStream >	OpenDataStream ()
	Opens the data stream. More...
std::shared_ptr< DataStream >	OpenedDataStream () const
	Returns the DataStream that was opened with this DataStreamDescriptor. More...
Public Member Functions inherited from peak::core::ModuleDescriptor
	ModuleDescriptor ()=default
virtual	~ModuleDescriptor ()=default
	ModuleDescriptor (const ModuleDescriptor &other)=delete
ModuleDescriptor &	operator= (const ModuleDescriptor &other)=delete
	ModuleDescriptor (ModuleDescriptor &&other)=delete
ModuleDescriptor &	operator= (ModuleDescriptor &&other)=delete
std::string	ID () const
	Returns the ID of the described module. More...

Additional Inherited Members

Detailed Description

Encapsulates the GenTL functions associated with a GenTL DataStream module's ID.

This class allows to query information about a GenTL DataStream module without opening it. Furthermore, it allows to open this GenTL DataStream module.

Constructor & Destructor Documentation

DataStreamDescriptor() [1/3]

peak::core::DataStreamDescriptor::DataStreamDescriptor ( )

delete

~DataStreamDescriptor()

peak::core::DataStreamDescriptor::~DataStreamDescriptor ( )

overridedefault

DataStreamDescriptor() [2/3]

peak::core::DataStreamDescriptor::DataStreamDescriptor ( const DataStreamDescriptor &  other )

delete

DataStreamDescriptor() [3/3]

peak::core::DataStreamDescriptor::DataStreamDescriptor ( DataStreamDescriptor &&  other )

delete

Member Function Documentation

Key()

std::string peak::core::DataStreamDescriptor::Key ( ) const

inline

Returns the unique key.

The returned key is unique even across different producer libraries.

Returns

Unique key

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

OpenDataStream()

std::shared_ptr< DataStream > peak::core::DataStreamDescriptor::OpenDataStream ( )

inline

Opens the data stream.

Returns

Opened data stream

Since

1.0

Exceptions

BadAccessException	Access denied
InternalErrorException	An internal error has occurred.

OpenedDataStream()

std::shared_ptr< DataStream > peak::core::DataStreamDescriptor::OpenedDataStream ( ) const

inline

Returns the DataStream that was opened with this DataStreamDescriptor.

Returns

Opened DataStream

Since

1.0

Exceptions

BadAccessException

DataStream is not open

operator=() [1/2]

DataStreamDescriptor& peak::core::DataStreamDescriptor::operator= ( const DataStreamDescriptor &  other )

delete

operator=() [2/2]

DataStreamDescriptor& peak::core::DataStreamDescriptor::operator= ( DataStreamDescriptor &&  other )

delete

ParentDevice()

std::shared_ptr< Device > peak::core::DataStreamDescriptor::ParentDevice ( ) const

inline

Returns the parent device.

Returns

Parent device

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

---

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

• peak/data_stream/peak_data_stream_descriptor.hpp