This class is used to search and list system objects and may be instantiated only once.
More...
#include <bgapi2_genicam.hpp>
|
class | iterator |
| This class provides an iterator that can read or modify any object of the list. More...
|
|
|
void | Add (System *pSystem) |
| This function adds a GenTL producer to the system list. It can be used to e.g. load GenTL producer which were not found by the searching procedure of the Refresh function. More...
|
|
void | Refresh () |
| This functions starts the search for GenTL producers with file extension 'cti' and follows a fixed searching procedure. First, the directory containing the application is searched, then the directory containing the BGAPI GenICam-Consumer and then the directories specified in the GenICam variable (see remarks). By using the function SystemList::CreateInstanceFromPath the GenICam variable will be ignored and the specified path is used instead. The found GenTL producers will be inserted into the SystemList. More...
|
|
bo_uint64 | size () |
| This function delivers the number of GenTL producers in the system list. More...
|
|
void | clear () |
| This function removes all GenTL producer from the system list. More...
|
|
System * | operator[] (const String &systemid) |
| This operator allows the direct access to an object of the system list. More...
|
|
iterator | begin () |
| This function delivers an iterator on the top of the system list. More...
|
|
iterator | end () |
| This function delivers an iterator at the end of the system list. More...
|
|
iterator | find (const String &_keyval) |
| This function delivers an iterator on an object that is supposed to be found. If the object cannot be found, this functions delivers with an end-iterator. More...
|
|
|
static SystemList * | GetInstance () |
| This function creates and delivers a static instance of SystemList. The Instance will be created with the first call of this function. Every following call delivers always the same instance until the function ReleaseInstance is called. This approach makes sure that only one instance of this class can be created. More...
|
|
static void | ReleaseInstance () |
| This function releases the static instance of SystemList. More...
|
|
static SystemList * | CreateInstanceFromPath (String producerpath) |
| This function creates and delivers a specified static instance of SystemList. Only the passed path will be used while searching for GenTL producers. The searching procedure described in function SystemList::Refresh is not used when the Systemlist is created with this function. More...
|
|
This class is used to search and list system objects and may be instantiated only once.
Definition at line 54 of file bgapi2_genicam.hpp.
◆ Add()
BGAPI2::SystemList::Add |
( |
System * |
pSystem | ) |
|
This function adds a GenTL producer to the system list. It can be used to e.g. load GenTL producer which were not found by the searching procedure of the Refresh function.
- Parameters
-
pSystem | The GenTL producer to be added. |
- Returns
- void
- Exceptions
-
◆ begin()
BGAPI2::SystemList::begin |
( |
| ) |
|
This function delivers an iterator on the top of the system list.
- Returns
- iterator The iterator on the top of the system list.
- Exceptions
-
◆ clear()
BGAPI2::SystemList::clear |
( |
| ) |
|
This function removes all GenTL producer from the system list.
- Returns
- void
- Exceptions
-
◆ CreateInstanceFromPath()
BGAPI2::SystemList::CreateInstanceFromPath |
( |
String |
producerpath | ) |
|
|
static |
This function creates and delivers a specified static instance of SystemList. Only the passed path will be used while searching for GenTL producers. The searching procedure described in function SystemList::Refresh is not used when the Systemlist is created with this function.
The specified instance of SystemList class is only created when it is used before the first call of function SystemList::GetInstance.
- Parameters
-
producerpath | This is the searching path for GenTL producers. |
- Returns
- The Pointer to the static instance of class SystemList.
- Exceptions
-
◆ end()
BGAPI2::SystemList::end |
( |
| ) |
|
This function delivers an iterator at the end of the system list.
- Returns
- iterator The iterator at the end of the system list.
- Exceptions
-
◆ find()
BGAPI2::SystemList::find |
( |
const String & |
_keyval | ) |
|
This function delivers an iterator on an object that is supposed to be found. If the object cannot be found, this functions delivers with an end-iterator.
- Parameters
-
_keyval | The ID to the object to be found. |
- Returns
- iterator The iterator to the found object.
- Exceptions
-
◆ GetInstance()
BGAPI2::SystemList::GetInstance |
( |
| ) |
|
|
static |
This function creates and delivers a static instance of SystemList. The Instance will be created with the first call of this function. Every following call delivers always the same instance until the function ReleaseInstance is called. This approach makes sure that only one instance of this class can be created.
If the function CreateInstanceFromPath is used before the first call to this function, this function delivers the pointer to the instance created by CreateInstanceFromPath.
- Returns
- SystemList * The Pointer to the static instance of class SystemList.
◆ operator[]()
BGAPI2::SystemList::operator[] |
( |
const String & |
systemid | ) |
|
This operator allows the direct access to an object of the system list.
- Parameters
-
systemid | For this ID, the associated system object is delivered. |
- Returns
- System* The requested system object.
- Exceptions
-
◆ Refresh()
BGAPI2::SystemList::Refresh |
( |
| ) |
|
This functions starts the search for GenTL producers with file extension 'cti' and follows a fixed searching procedure. First, the directory containing the application is searched, then the directory containing the BGAPI GenICam-Consumer and then the directories specified in the GenICam variable (see remarks). By using the function SystemList::CreateInstanceFromPath the GenICam variable will be ignored and the specified path is used instead. The found GenTL producers will be inserted into the SystemList.
- Returns
- void
- Exceptions
-
◆ ReleaseInstance()
BGAPI2::SystemList::ReleaseInstance |
( |
| ) |
|
|
static |
This function releases the static instance of SystemList.
- Returns
- void
◆ size()
BGAPI2::SystemList::size |
( |
| ) |
|
This function delivers the number of GenTL producers in the system list.
- Returns
- bo_uint64 The number of GenTL producers in the system list.
- Exceptions
-
The documentation for this class was generated from the following file: