CVB++ 14.0
DiscoveryInformation Class Referencefinal

Stores information on a discovered device/node. More...

#include <cvb/driver/discovery_information.hpp>

Public Member Functions

int Index () const noexcept
 Gets the index of this element in the list. More...
 
void SetGenApiFeature (const String &nodeMapId, const String &featureName, const String &featureValue)
 Sets a GenICam GenApi feature to be set with a new discover run or while opening a device via this information. More...
 
void SetParameter (const String &name, const String &value)
 Sets a custom GenTL Producer dependent parameter. More...
 
String AccessToken () const
 The access token for opening the device/node. More...
 
ModuleLayer DiscoveryLayer () const noexcept
 Gets the highest module layer in this discovery information. More...
 
bool TryGetProperty (DiscoveryProperties id, String &property) const noexcept
 Tries to get the value of the information property with the given id. More...
 
String operator[] (DiscoveryProperties id) const
 Gets the value of the information property with the given id. More...
 
DiscoveryInformationoperator= (DiscoveryInformation &&other)=default
 move assignment operator. More...
 

Detailed Description

Stores information on a discovered device/node.

Member Function Documentation

◆ AccessToken()

String AccessToken ( ) const
inline

The access token for opening the device/node.

Returns
Access token string.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ DiscoveryLayer()

ModuleLayer DiscoveryLayer ( ) const
inlinenoexcept

Gets the highest module layer in this discovery information.

Returns
The module layer.
Exceptions
Doesnot throw any exception.

◆ Index()

int Index ( ) const
inlinenoexcept

Gets the index of this element in the list.

Returns
The index.
Exceptions
Doesnot throw any exception.

◆ operator=()

DiscoveryInformation & operator= ( DiscoveryInformation &&  other)
default

move assignment operator.

Parameters
[in]otherObject holding the old data.
Returns
Reference to data's new object.
Exceptions
Doesnot throw any exception.

◆ operator[]()

String operator[] ( DiscoveryProperties  id) const
inline

Gets the value of the information property with the given id.

Parameters
[in]idInformation to get.
Returns
Text containing the information.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ SetGenApiFeature()

void SetGenApiFeature ( const String nodeMapId,
const String featureName,
const String featureValue 
)
inline

Sets a GenICam GenApi feature to be set with a new discover run or while opening a device via this information.

Parameters
[in]nodeMapIdID of the node map to get.
[in]featureNameName of the GenApi feature to set.
[in]featureValueValue of the GenApi feature to set.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ SetParameter()

void SetParameter ( const String name,
const String value 
)
inline

Sets a custom GenTL Producer dependent parameter.

Parameters
[in]nameName of the parameter to set.
[in]valueValue of the parameter to set.
Exceptions
Anyexception derived from std::exception including CvbException.

Contact the support of the GenTL Producer to get a list of available parameters to set.

Parameter information for CVB GenTL Producer
GenICam User Guide

◆ TryGetProperty()

bool TryGetProperty ( DiscoveryProperties  id,
String property 
) const
inlinenoexcept

Tries to get the value of the information property with the given id.

Parameters
[in]idInformation to get.
[out]propertyString containing the information if successful.
Returns
bool True if successful; false otherwise.
Exceptions
Doesnot throw any exception.