Logo
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
Classes | Public Member Functions | Friends | List of all members
BGAPI2::DataStreamList Class Reference

This class is used to discover and list data stream objects. More...

#include <bgapi2_genicam.hpp>

Classes

class  iterator
 This class provides an iterator that can read or modify any element in the list. More...
 

Public Member Functions

void Refresh ()
 This function provides a list of DataStream objects. More...
 
bo_uint64 size ()
 This function delivers the number of DataStream objects in the DataStream list. More...
 
void clear ()
 This function removes all DataStream objects from the DataStream list. More...
 
DataStreamoperator[] (const String &streamid)
 This operator allows the direct access to an object of the DataStream list. More...
 
iterator begin ()
 This function delivers an iterator on the top of the DataStream list. More...
 
iterator end ()
 This function delivers an iterator at the end of the DataStream list. More...
 
iterator find (const String &_keyval)
 This function delivers an iterator on an object to be found. If the object is not found, this functions delivers an end-iterator. More...
 

Friends

class Device
 

Detailed Description

This class is used to discover and list data stream objects.

Definition at line 533 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ begin()

BGAPI2::DataStreamList::begin ( )

This function delivers an iterator on the top of the DataStream list.

Returns
iterator The iterator on the top of the DataStream list.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.

◆ clear()

BGAPI2::DataStreamList::clear ( )

This function removes all DataStream objects from the DataStream list.

Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.

◆ end()

BGAPI2::DataStreamList::end ( )

This function delivers an iterator at the end of the DataStream list.

Returns
iterator The iterator at the end of the DataStream list.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.

◆ find()

BGAPI2::DataStreamList::find ( const String _keyval)

This function delivers an iterator on an object to be found. If the object is not found, this functions delivers an end-iterator.

Parameters
_keyvalThe ID to the object to be found.
Returns
iterator The iterator to the found object.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.

◆ operator[]()

BGAPI2::DataStreamList::operator[] ( const String streamid)

This operator allows the direct access to an object of the DataStream list.

Parameters
streamidFor this ID, the associated DataStream object is delivered.
Returns
DataStream* The requested DataStream object.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::InvalidParameterExceptionNo object in the DataStream list has the passed ID.

◆ Refresh()

BGAPI2::DataStreamList::Refresh ( )

This function provides a list of DataStream objects.

Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::LowLevelExceptionGenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information.

◆ size()

BGAPI2::DataStreamList::size ( )

This function delivers the number of DataStream objects in the DataStream list.

Returns
bo_uint64 The number of DataStream objects in the DataStream list.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.

The documentation for this class was generated from the following file:
bgapi: BGAPI::Camera Class Reference

Jan, 14 2020
Baumer Optronic GmbH, Badstrasse 30, 01454 D-Radeberg, Tel:+49-3528-4386-0, Fax:+49-3528-4386-86, Email:support.cameras@baumer.com