DiscoveryInformation Struct Reference

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

Public Member Functions
IEnumerator< KeyValuePair< DiscoveryProperties, string > >	GetEnumerator ()
	Gets the typed enumerator for the available information properties.
IEnumerator IEnumerable.	GetEnumerator ()
	Gets the untyped enumerator for the available information properties.
override string	ToString ()
	Gets the access token as a string representation.
bool	TryGetProperty (DiscoveryProperties id, out string property)
	Tries to get the value of the information property with the given id .
void	SetGenApiFeature (string nodeMapId, string featureName, string featureValue)
	Sets a GenICam GenApi feature to be set with a new DeviceFactory.Discover(DiscoveryInformation) run or while opening a Device via this information.
void	SetParameter (string name, string value)
	Sets a custom GenTL Producer dependent parameter.

Properties
DiscoveryInformationList	Parent [get]
	Gets the parent list.
int	Index [get]
	Gets the index of this element in the Parent list.
string	AccessToken [get]
	The access token for opening the device/node.
ModuleLayer	DiscoveryLayer [get]
	Gets the highest ModuleLayer in this discovery information.
string	this[DiscoveryProperties id] [get]
	Gets the value of the information property with the given id .

Detailed Description

Stores information on a discovered device/node.

Member Function Documentation

GetEnumerator() [1/2]

IEnumerator< KeyValuePair< DiscoveryProperties, string > > GetEnumerator

(

)

Gets the typed enumerator for the available information properties.

Returns

Available information enumerator.

GetEnumerator() [2/2]

IEnumerator IEnumerable. GetEnumerator

(

)

Gets the untyped enumerator for the available information properties.

Returns

Available information enumerator.

SetGenApiFeature()

void SetGenApiFeature	(	string	nodeMapId,
		string	featureName,
		string	featureValue )

Sets a GenICam GenApi feature to be set with a new DeviceFactory.Discover(DiscoveryInformation) run or while opening a Device via this information.

The feature is set on this DiscoveryLayer module.

Parameters

nodeMapId	ID of the nodemap to get featureName from. The identifiers are defined on NodeMapDictionary.
featureName	Name of the GenApi feature to set.
featureValue	Value of the GenApi feature to set.

Exceptions

ObjectDisposedException	If Parent has been disposed.
ArgumentNullException	If one of the string arguments is null.

SetParameter()

void SetParameter	(	string	name,
		string	value )

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

name	Name of the parameter to set.
value	Value of the parameter to set.

Exceptions

ObjectDisposedException	If Parent has been disposed.
ArgumentNullException	If one of the string arguments is null.

ToString()

override string ToString

(

)

Gets the access token as a string representation.

Returns

The access token.

TryGetProperty()

bool TryGetProperty	(	DiscoveryProperties	id,
		out string	property )

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

Parameters

id	Information to get.
property	Text containing the information if successful.

Returns

true if successful; false otherwise.

Property Documentation

AccessToken

string AccessToken

get

The access token for opening the device/node.

Also supports additional (parameterized) queries.

this[DiscoveryProperties id]

string this[DiscoveryProperties id]

get

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

Parameters

id	Information to get.

Returns

Text containing the information.