Impact Acquire SDK .NET
|
A class that contains items to configure the behaviour of the GenICam GenTL driver stack. More...
Public Attributes | |
EnumPropertyI< TInterfaceEnumerationBehaviour > | masterEnumerationBehaviour = new EnumPropertyI<TInterfaceEnumerationBehaviour>() |
An enumerated integer property defining the master enumeration mode for all GenTL producer detected in the current session. | |
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. | |
List< GenTLProducerConfiguration > | producerConfigurations [get] |
Returns a vector containing all mv.impact.acquire.GenICam.GenTLProducerConfiguration objects currently defined. | |
A class that contains items to configure the behaviour of the GenICam GenTL driver stack.
This class contains items e.g. to configure the enumeration behaviour of third party GenTL producer libraries.
Since version 2.32.0 Impact Acquire has built-in support for third party GenTL producer libraries. The latest version of the GenTL specification can be found here: https://www.emva.org/standards-technology/genicam/.
Detection of GenTL producer libraries works by evaluating the GENICAM_GENTL32_PATH
environment variable within a 32-bit process or the GENICAM_GENTL64_PATH
variable in a 64-bit process. This variable contains a list of directories that might potentially contain GenTL producer libraries. These libraries use a the file extension .cti and export a defined interface.
All libraries that fulfill these requirements will be loaded into the Impact Acquire process. By default all these libraries will then also be enumerated for connected/bound devices. The only exception will be if a third party producer is found that reports an interface supporting the same technology as one delivered by Impact Acquire (e.g. for the GigE Vision or USB3 Vision standard). These interfaces by default will not be enumerated.
The purpose of this class now is to allow an application to modify this behaviour. This might be beneficial for several reasons:
To exclude a certain producer from enumeration first a mv.impact.acquire.GenICam.GenTLProducerConfiguration entry for that producer must be created and then the mv.impact.acquire.GenICam.GenTLProducerConfiguration.enumerationEnable property for this producer must be set to mv.impact.acquire.TBoolean.bFalse.
EXAMPLE:
To exclude a certain interface from a producer from enumeration an mv.impact.acquire.GenICam.GenTLProducerConfiguration.enumerationEnable property for this producer can be set to mv.impact.acquire.TBoolean.bFalse and the interface enumeration behaviour should be set to mv.impact.acquire.TInterfaceEnumerationBehaviour.iebForceEnumerate.
EXAMPLE:
The same thing can be done the other way round:
EXAMPLE:
|
inline |
Constructs a new mv.impact.acquire.GenICam.GenTLDriverConfigurator object.
|
inline |
Creates a new mv.impact.acquire.GenICam.GenTLProducerConfiguration object for the desired interface reported by the specified producer.
Calling this function will creates a new mv.impact.acquire.GenICam.GenTLProducerConfiguration object for the desired interface reported by the specified producer.
[in] | producerName | The exact name of the producer library without the path to create the entry for. |
|
inline |
Creates a new mv.impact.acquire.GenICam.GenTLProducerConfiguration object for the desired interface reported by the specified producer.
Calling this function will creates a new mv.impact.acquire.GenICam.GenTLProducerConfiguration object for the desired interface reported by the specified producer.
[in] | producerName | The exact name of the producer library without the path to create the entry for. |
[in] | interfaceID | The interface ID to create the configuration entry for. |
|
inline |
Deletes all mv.impact.acquire.GenICam.GenTLProducerConfiguration objects.
Calling this function will result in all mv.impact.acquire.GenICam.GenTLProducerConfiguration objects to be deleted. When the next Impact Acquire process will be started after shutting down the current one all producer libraries found on the system will be processed. By default only interfaces reporting types/technologies (e.g. GigE Vision) also supported by Balluff will be ignored (will not enumerate devices) then.
Deletes a mv.impact.acquire.GenICam.GenTLProducerConfiguration objects.
Calling this function will delete the mv.impact.acquire.GenICam.GenTLProducerConfiguration object for the referenced producer.
[in] | producerName | The exact name of the producer library without the path to delete the entry from. |
|
inlineinherited |
Returns an enumerator of a certain type that iterates through the collection.
This interface will allow to e.g. write code like this:
See the frameworks documentation about the System.Collections.IEnumerable interface for more information.
|
inlineinherited |
Returns an enumerator that iterates through the collection.
See the frameworks documentation about the System.Collections.IEnumerable interface for more information.
|
inline |
Returns the mv.impact.acquire.GenICam.GenTLProducerConfiguration associated with the referenced producer library.
[in] | producerName | The exact name of the producer library without the path. |
Checks if a certain producer library has been associated with a mv.impact.acquire.GenICam.GenTLProducerConfiguration.
[in] | producerName | The exact name of the producer library without the path. |
|
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.
EnumPropertyI<TInterfaceEnumerationBehaviour> masterEnumerationBehaviour = new EnumPropertyI<TInterfaceEnumerationBehaviour>() |
An enumerated integer property defining the master enumeration mode for all GenTL producer detected in the current session.
Valid values for this property are defined by the enumeration mv.impact.acquire.TInterfaceEnumerationBehaviour.
|
getinherited |
Returns an enumerator that iterates through the collection.
This interface will allow to e.g. write code like this:
See the frameworks documentation about the System.Collections.IEnumerable interface for more information.
|
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:
See the frameworks documentation about the System.Collections.IEnumerable interface for more information.
|
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.
|
get |
Returns a vector containing all mv.impact.acquire.GenICam.GenTLProducerConfiguration objects currently defined.