This class is used to search and list interface objects.
More...
#include <bgapi2_genicam.hpp>
|
class | iterator |
| This class provides a iterator that can read or modify any element in the list. More...
|
|
|
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...
|
|
Interface * | operator[] (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...
|
|
This class is used to search and list interface objects.
Definition at line 239 of file bgapi2_genicam.hpp.
◆ 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
-
◆ clear()
BGAPI2::InterfaceList::clear |
( |
| ) |
|
This function removes all interface objects from the interface list.
- Exceptions
-
◆ 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
-
◆ 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
-
_keyval | The ID to the object to be found. |
- Returns
- iterator The iterator to the found object.
- Exceptions
-
◆ operator[]()
BGAPI2::InterfaceList::operator[] |
( |
const String & |
ifaceid | ) |
|
This operator allows the direct access to an object of the interface list.
- Parameters
-
ifaceid | For this ID, the associated system object is delivered. |
- Returns
- Interface* The requested interface object.
- Exceptions
-
◆ 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
-
iTimeout | After this time, the function delivers latest. |
- Exceptions
-
◆ 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
-
The documentation for this class was generated from the following file: