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

This class is used to search and list interface 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 Interfaces and provides a list of interface objects. The search is controlled by a timeout parameter. This function delivers, if at least one interface object was found, but not later than after the set timeout period (see comments). More...
 
bo_uint64 size ()
 This function delivers the number of interface objects in the interface list. More...
 
void clear ()
 This function removes all interface objects from the interface list. More...
 
Interfaceoperator[] (const String &ifaceid)
 This operator allows the direct access to an object of the interface list. More...
 
iterator begin ()
 This functions delivers an iterator on the top of the interface list. More...
 
iterator end ()
 This functions delivers an iterator at the end of the interface list. More...
 
iterator find (const String &_keyval)
 This function delivers an iterator on an object to be found. If the object cannot be found, this functions delivers an end-iterator. More...
 

Friends

class System
 

Detailed Description

This class is used to search and list interface objects.

Definition at line 239 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ begin()

BGAPI2::InterfaceList::begin ( )

This functions delivers an iterator on the top of the interface list.

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

◆ clear()

BGAPI2::InterfaceList::clear ( )

This function removes all interface objects from the interface 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::InterfaceList::end ( )

This functions delivers an iterator at the end of the interface list.

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

◆ find()

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

This function delivers an iterator on an object to be found. If the object cannot be 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::InterfaceList::operator[] ( const String ifaceid)

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

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

◆ Refresh()

BGAPI2::InterfaceList::Refresh ( bo_uint64  iTimeout)

This function starts the search for Interfaces and provides a list of interface objects. The search is controlled by a timeout parameter. This function delivers, if at least one interface object was found, but not 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::InterfaceList::size ( )

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

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