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

This class is used to discover and list device objects. More...

#include <bgapi2_genicam.hpp>

Classes

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

Public Member Functions

void Refresh (bo_uint64 iTimeout)
 This function starts the search for Devices and provides a list of device objects. The search is controlled by a timeout parameter. This function delivers, if at least one device object were found, but no later than after the set timeout period (see comments). More...
 
bo_uint64 size ()
 This function delivers the number of device objects in the device list. More...
 
void clear ()
 This function removes all device objects from the device list. More...
 
Deviceoperator[] (const String &devid)
 This operator allows the direct access to an object of the device list. More...
 
iterator begin ()
 This function delivers an iterator on the top of the device list. More...
 
iterator end ()
 This function delivers an iterator at the end of the device list. More...
 
iterator find (const String &_keyval)
 This function delivers an iterator on an object to be found. The object is not found, this functions delivers an end-iterator. More...
 

Friends

class Interface
 

Detailed Description

This class is used to discover and list device objects.

Definition at line 386 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ begin()

BGAPI2::DeviceList::begin ( )

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

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

◆ clear()

BGAPI2::DeviceList::clear ( )

This function removes all device objects from the device list.

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

◆ end()

BGAPI2::DeviceList::end ( )

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

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

◆ find()

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

This function delivers an iterator on an object to be found. 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::DeviceList::operator[] ( const String devid)

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

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

◆ Refresh()

BGAPI2::DeviceList::Refresh ( bo_uint64  iTimeout)

This function starts the search for Devices and provides a list of device objects. The search is controlled by a timeout parameter. This function delivers, if at least one device object were found, but no later than after the set timeout period (see comments).

Parameters
iTimeoutAfter this time, the function delivers latest.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::LowLevelExceptionGenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information.
Remarks
This function has a minimum execution time, which also works when the timeout set is smaller then the minimum execution time.

◆ size()

BGAPI2::DeviceList::size ( )

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

Returns
bo_uint64 The number of device objects in the device 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