DiscoveryInformation Class Reference

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

#include <cvb/driver/discovery_information.hpp>

Public Member Functions
DiscoveryInformation &	operator= (DiscoveryInformation &&other)=default
	move assignment operator.
int	Index () const noexcept
	Gets the index of this element in the list.
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.
void	SetParameter (const String &name, const String &value)
	Sets a custom GenTL Producer dependent parameter.
String	AccessToken () const
	The access token for opening the device/node.
ModuleLayer	DiscoveryLayer () const noexcept
	Gets the highest module layer in this discovery information.
bool	TryGetProperty (DiscoveryProperties id, String &property) const noexcept
	Tries to get the value of the information property with the given id.
String	operator[] (DiscoveryProperties id) const
	Gets the value of the information property with the given id.

Detailed Description

Stores information on a discovered device/node.

Online Manual

Device Configuration

Member Function Documentation

AccessToken()

String AccessToken ( ) const

inline

The access token for opening the device/node.

Returns

Access token string.

Exceptions

Any	exception 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

Does	not throw any exception.

Index()

int Index ( ) const

inlinenoexcept

Gets the index of this element in the list.

Returns

The index.

Exceptions

Does	not throw any exception.

operator=()

DiscoveryInformation & operator= ( DiscoveryInformation && other )

default

move assignment operator.

Parameters

[in]

other

Object holding the old data.

Returns

Reference to data's new object.

Exceptions

Does	not throw any exception.

operator[]()

String operator[] ( DiscoveryProperties id ) const

inline

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

Parameters

[in]

id

Information to get.

Returns

Text containing the information.

Exceptions

Any	exception 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]	nodeMapId	ID of the node map to get.
[in]	featureName	Name of the GenApi feature to set.
[in]	featureValue	Value of the GenApi feature to set.

Exceptions

Any	exception derived from std::exception including CvbException.

SetParameter()

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

inline

Sets a custom GenTL Producer dependent parameter.

Parameter descriptions can be found in the Device Configuration section of the CVB online documentation.

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

Parameters

[in]	name	Name of the parameter to set.
[in]	value	Value of the parameter to set.

Exceptions

Any	exception derived from std::exception including CvbException.

TryGetProperty()

bool TryGetProperty ( DiscoveryProperties id, String & property ) const

inlinenoexcept

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

Parameters

[in]	id	Information to get.
[out]	property	String containing the information if successful.

Returns

bool True if successful; false otherwise.

Exceptions

Does	not throw any exception.