mvIMPACT Acquire SDK C++
GenTLProducerConfiguration Class Reference

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

Inheritance diagram for GenTLProducerConfiguration:
ComponentCollection

Public Member Functions

PropertyIInterfaceEnumerationBehaviour createProducerInterfaceConfigurationEntry (const std::string &interfaceID)
 Creates a new interface configuration entry for this producers configuration. More...
 
void deleteProducerInterfaceConfigurationEntry (const std::string &interfaceID)
 Deletes an interface configuration entry from this producers configuration. More...
 
 GenTLProducerConfiguration (const GenTLProducerConfiguration &src)
 Constructs a new mvIMPACT::acquire::GenICam::GenTLProducerConfiguration from an existing one. More...
 
PropertyIInterfaceEnumerationBehaviour getInterfaceEnumerationBehaviour (const std::string &interfaceID) const
 Returns the interface enumeration behaviour property for the specified interface ID for this particular GenTL producer. More...
 
std::map< std::string, PropertyIInterfaceEnumerationBehaviourgetInterfaceEnumerationBehaviours (void) const
 Returns a map containing all the configured interface IDs and their corresponding enumeration behaviour properties for this particular GenTL producer. More...
 
std::string getProducerName (void) const
 Returns the name of the GenTL producer associated with this configuration object. More...
 
HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
GenTLProducerConfigurationoperator= (const GenTLProducerConfiguration &rhs)
 Allows assignments of mvIMPACT::acquire::GenICam::GenTLProducerConfiguration objects. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

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

Protected Attributes

HOBJ m_hRoot
 

Friends

class GenTLDriverConfigurator
 

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

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

See also
Setting Up The Framework For Third Party GenTL Producer Usage
Since
2.34.0

Constructor & Destructor Documentation

◆ GenTLProducerConfiguration()

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

Parameters
[in]srcA constant reference to the mvIMPACT::acquire::GenICam::GenTLProducerConfiguration object, this object shall be created from

Member Function Documentation

◆ createProducerInterfaceConfigurationEntry()

PropertyIInterfaceEnumerationBehaviour createProducerInterfaceConfigurationEntry ( const std::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]interfaceIDThe interface ID to create the configuration entry for.

◆ deleteProducerInterfaceConfigurationEntry()

void deleteProducerInterfaceConfigurationEntry ( const std::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]interfaceIDThe exact interface ID of the producers list of reported interfaces to delete the configuration entry for.

◆ getInterfaceEnumerationBehaviour()

PropertyIInterfaceEnumerationBehaviour getInterfaceEnumerationBehaviour ( const std::string &  interfaceID) const
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 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
[in]interfaceIDThe interface ID previously passed e.g. to the mvIMPACT::acquire::GenICam::GenTLProducerConfiguration::createProducerInterfaceConfigurationEntry function.

◆ getInterfaceEnumerationBehaviours()

std::map<std::string, PropertyIInterfaceEnumerationBehaviour> getInterfaceEnumerationBehaviours ( void  ) const
inline

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::GenICam::GenTLProducerConfiguration::createProducerInterfaceConfigurationEntry. Certain third party interfaces might also have an entry in this map (e.g. if there is a MATRIX VISION 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()

std::string getProducerName ( void  ) const
inline

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

HOBJ hObj ( void  ) const
inlineinherited

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.

◆ operator=()

◆ restoreDefault()

const ComponentCollection& restoreDefault ( void  ) const
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.
Returns
A const reference to the component.

Friends And Related Function Documentation

◆ GenTLDriverConfigurator

friend class GenTLDriverConfigurator
friend

Member Data Documentation

◆ enumerationEnable

PropertyIBoolean enumerationEnable

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 are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

The documentation for this class was generated from the following file: