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
PropertyI	createProducerInterfaceConfigurationEntry (String interfaceID)
	Creates a new interface configuration entry for this producers configuration.
synchronized void	delete ()
void	deleteProducerInterfaceConfigurationEntry (String interfaceID)
	Deletes an interface configuration entry from this producers configuration.
	GenTLProducerConfiguration (GenTLProducerConfiguration src)
	Constructs a new mvIMPACT.acquire.GenTLProducerConfiguration from an existing one.
PropertyI	getEnumerationEnable ()
	An enumerated integer property defining the enumeration behavior this particular GenTL producer.
PropertyI	getInterfaceEnumerationBehaviour (String interfaceID)
	Returns the interface enumeration behaviour property for the specified interface ID for this particular GenTL producer.
StringPropertyIMap	getInterfaceEnumerationBehaviours ()
	Returns a map containing all the configured interface IDs and their corresponding enumeration behaviour properties for this particular GenTL producer.
String	getProducerName ()
	Returns the name of the GenTL producer associated with this configuration object.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()
	GenTLProducerConfiguration (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (GenTLProducerConfiguration obj)

Protected Attributes
transient boolean	swigCMemOwn

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

GenTLProducerConfiguration() [1/2]

GenTLProducerConfiguration ( long cPtr, boolean cMemoryOwn )

protected

GenTLProducerConfiguration() [2/2]

GenTLProducerConfiguration

(

GenTLProducerConfiguration

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

Member Function Documentation

createProducerInterfaceConfigurationEntry()

PropertyI createProducerInterfaceConfigurationEntry

(

String

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.

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

deleteProducerInterfaceConfigurationEntry()

void deleteProducerInterfaceConfigurationEntry

(

String

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.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getEnumerationEnable()

PropertyI getEnumerationEnable

(

)

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

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

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

getInterfaceEnumerationBehaviour()

PropertyI getInterfaceEnumerationBehaviour

(

String

interfaceID

)

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 mvIMPACT.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

interfaceID

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

getInterfaceEnumerationBehaviours()

StringPropertyIMap getInterfaceEnumerationBehaviours

(

)

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()

String getProducerName

(

)

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

Returns

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

hObj()

int hObj ( )

inherited

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

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

Returns

A unique identifier for the component referenced by this object.

restoreDefault()

ComponentCollection restoreDefault ( )

inherited

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.

Returns

A const reference to the component.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( GenTLProducerConfiguration obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited