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
	__init__ (self, src)
	Constructs a new mvIMPACT.acquire.GenTLProducerConfiguration from an existing one.
	createProducerInterfaceConfigurationEntry (self, interfaceID)
	Creates a new interface configuration entry for this producers configuration.
	deleteProducerInterfaceConfigurationEntry (self, interfaceID)
	Deletes an interface configuration entry from this producers configuration.
	getInterfaceEnumerationBehaviour (self, interfaceID)
	Returns the interface enumeration behaviour property for the specified interface ID for this particular GenTL producer.
	getInterfaceEnumerationBehaviours (self)
	Returns a map containing all the configured interface IDs and their corresponding enumeration behaviour properties for this particular GenTL producer.
	getProducerName (self)
	Returns the name of the GenTL producer associated with this configuration object.

Properties
	enumerationEnable = property(lib_mvIMPACT_acquire.GenTLProducerConfiguration_enumerationEnable_get, doc=)
	An enumerated integer property defining the enumeration behavior this particular GenTL producer.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

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 mvIMPACT.acquire.GenTLDriverConfigurator.createProducerConfiguration, mvIMPACT.acquire.GenTLDriverConfigurator.getProducerConfigurations or mvIMPACT.acquire.GenTLDriverConfigurator.getProducerConfiguration must be used. must be used.

For a comprehensive usage example see the description of the class mvIMPACT.acquire.GenTLDriverConfigurator.

See also

Setting Up The Framework For Third Party GenTL Producer Usage

Since

2.34.0

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			src )

Constructs a new mvIMPACT.acquire.GenTLProducerConfiguration from an existing one.

Parameters

src	[in] A constant reference to the mvIMPACT.acquire.GenTLProducerConfiguration object, this object shall be created from

Reimplemented from ComponentCollection.

Member Function Documentation

createProducerInterfaceConfigurationEntry()

createProducerInterfaceConfigurationEntry	(		self,
			interfaceID )

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

interfaceID

[in] The interface ID to create the configuration entry for.

deleteProducerInterfaceConfigurationEntry()

deleteProducerInterfaceConfigurationEntry	(		self,
			interfaceID )

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

interfaceID

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

getInterfaceEnumerationBehaviour()

getInterfaceEnumerationBehaviour	(		self,
			interfaceID )

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

Valid values for this property may be: mvIMPACT.acquire.iebNotConfigured, mvIMPACT.acquire.iebForceIgnore, mvIMPACT.acquire.iebForceEnumerate.

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

interfaceID

[in] The interface ID previously passed e.g. to the mvIMPACT.acquire.GenTLProducerConfiguration.createProducerInterfaceConfigurationEntry function.

getInterfaceEnumerationBehaviours()

getInterfaceEnumerationBehaviours

(

self

)

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 mvIMPACT.acquire.GenTLProducerConfiguration.createProducerInterfaceConfigurationEntry. Certain third party interfaces might also have an entry in this map (e.g. if there is a Balluff GenICam GenTL producer supporting the same technology present on the system).

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

Returns

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

getProducerName()

getProducerName

(

self

)

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

Returns

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

Property Documentation

enumerationEnable

enumerationEnable = property(lib_mvIMPACT_acquire.GenTLProducerConfiguration_enumerationEnable_get, doc=)

static

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

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

Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static