GenTLProducerConfiguration Class Reference

A class that contains items to configure the behaviour of the GenICam GenTL driver stack. More...

Inheritance diagram for GenTLProducerConfiguration:

Public Member Functions
EnumPropertyI< TInterfaceEnumerationBehaviour >	createProducerInterfaceConfigurationEntry (String interfaceID)
	Creates a new interface configuration entry for this producers configuration.
void	deleteProducerInterfaceConfigurationEntry (String interfaceID)
	Deletes an interface configuration entry from this producers configuration.
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.
IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.
EnumPropertyI< TInterfaceEnumerationBehaviour >	getInterfaceEnumerationBehaviour (String interfaceID)
	Returns the interface enumeration behaviour property for the specified interface ID for this particular GenTL producer.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
PropertyIBoolean	enumerationEnable = new PropertyIBoolean()
	An enumerated integer property defining the enumeration behavior this particular GenTL producer.

Properties
IEnumerable< Component >	componentEnumerable [get]
	Returns an enumerator that iterates through the collection.
IEnumerable< ComponentList >	componentListEnumerable [get]
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.
Dictionary< String, EnumPropertyI< TInterfaceEnumerationBehaviour > >	interfaceEnumerationBehaviours [get]
	Returns a map containing all the configured interface IDs and their corresponding enumeration behaviour properties for this particular GenTL producer.
String	producerName [get]
	Returns the name of the GenTL producer associated with this configuration object.

Detailed Description

A class that contains items to configure the behaviour of the GenICam GenTL driver stack.

This class contains items to configure the enumeration behaviour of a third party GenTL producer library.

Note

Instances of this class cannot be constructed directly. To get access the functions mv.impact.acquire.GenICam.GenTLDriverConfigurator.createProducerConfiguration, mv.impact.acquire.GenICam.GenTLDriverConfigurator.getProducerConfigurations or mv.impact.acquire.GenICam.GenTLDriverConfigurator.getProducerConfiguration must be used. must be used.

For a comprehensive usage example see the description of the class mv.impact.acquire.GenICam.GenTLDriverConfigurator.

See also

Setting Up The Framework For Third Party GenTL Producer Usage

Since

2.34.0

Member Function Documentation

createProducerInterfaceConfigurationEntry()

EnumPropertyI< TInterfaceEnumerationBehaviour > createProducerInterfaceConfigurationEntry ( String interfaceID )

inline

Creates a new interface configuration entry for this producers configuration.

Usually the parameter passed to this function will be one of the interface IDs of the producers list of reported interfaces in order to configure this particular interface. However it can also be an identifier for an interface not yet connected to the system or not yet available to the producer. No internal checks are performed regarding the validity of the given interface ID.

Note

If an entry with the same interface ID already exists an exception will be thrown.

Parameters

[in]

interfaceID

The interface ID to create the configuration entry for.

deleteProducerInterfaceConfigurationEntry()

void deleteProducerInterfaceConfigurationEntry ( String interfaceID )

inline

Deletes an interface configuration entry from this producers configuration.

Note

If no entry for the specified interface can be found an exception will be thrown.

Parameters

[in]

interfaceID

The exact interface ID of the producers list of reported interfaces to delete the configuration entry for.

getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )

inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
  validateProperty(c);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

GetEnumerator()

IEnumerator< int > GetEnumerator ( )

inlineinherited

Returns an enumerator that iterates through the collection.

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

getInterfaceEnumerationBehaviour()

EnumPropertyI< TInterfaceEnumerationBehaviour > getInterfaceEnumerationBehaviour ( String interfaceID )

inline

Returns the interface enumeration behaviour property for the specified interface ID for this particular GenTL producer.

Valid values for this property are defined by the enumeration mv.impact.acquire.TInterfaceEnumerationBehaviour.

Note

If no entry for the specified interface ID exists an exception will be thrown.

Returns

The enumeration behaviour configuration property for the specified interface

Parameters

[in]

interfaceID

The interface ID previously passed e.g. to the mv.impact.acquire.GenICam.GenTLProducerConfiguration::createProducerInterfaceConfigurationEntry function.

restoreDefault()

void restoreDefault ( )

inlineinherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Member Data Documentation

enumerationEnable

PropertyIBoolean enumerationEnable = new PropertyIBoolean()

An enumerated integer property defining the enumeration behavior this particular GenTL producer.

If this property is set to mv.impact.acquire.TBoolean.bTrue ALL interfaces of this producer will be enumerated unless a specific interface enumeration behaviour has been set to mv.impact.acquire.TInterfaceEnumerationBehaviour.iebForceIgnore.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

Property Documentation

componentEnumerable

IEnumerable<Component> componentEnumerable

getinherited

Returns an enumerator that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
  Console.WriteLine("{0}", c.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable

getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
  Console.WriteLine("{0}", cl.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

hObj

int hObj

getinherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mv.impact.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.

interfaceEnumerationBehaviours

Dictionary<String, EnumPropertyI<TInterfaceEnumerationBehaviour> > interfaceEnumerationBehaviours

get

Returns a map containing all the configured interface IDs and their corresponding enumeration behaviour properties for this particular GenTL producer.

The returned map will only contain interface IDs which have explicitly been configured (e.g. by a previous call to mv.impact.acquire.GenICam.GenTLProducerConfiguration::createProducerInterfaceConfigurationEntry. Certain third party interfaces might also have an entry in this map (e.g. if there is a Balluff producer supporting the same technology present on the system).

Valid values for the properties are defined by the enumeration mv.impact.acquire.TInterfaceEnumerationBehaviour.

Returns

A map containing all the configured interface IDs and their corresponding enumeration behaviour properties for this particular GenTL producer

producerName

String producerName

get

Returns the name of the GenTL producer associated with this configuration object.

Returns

The name of the GenTL producer associated with this configuration object.