mvIMPACT Acquire SDK C++

Category that contains features to control the devices Current Control parameters. More...

Inheritance diagram for mvCurrentControl:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 mvCurrentControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::mvCurrentControl object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI64 mvCurrent
 An integer property. Sets the current value for the selected device(e.g.: LED). More...
 
PropertyI64 mvCurrentSelector
 An enumerated integer property. Selects the current source to configure. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Category that contains features to control the devices Current Control parameters.

A category that contains features to control the devices Current Control parameters.

Constructor & Destructor Documentation

◆ mvCurrentControl()

mvCurrentControl ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::mvCurrentControl object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT::acquire::FunctionInterface::getAvailableSettings, new settings can be created with the function mvIMPACT::acquire::FunctionInterface::createSetting

Member Function Documentation

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

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

Member Data Documentation

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ mvCurrent

PropertyI64 mvCurrent

An integer property. Sets the current value for the selected device(e.g.: LED).

Sets the current value for the selected device(e.g.: LED).

◆ mvCurrentSelector

PropertyI64 mvCurrentSelector

An enumerated integer property. Selects the current source to configure.

Selects the current source to configure.

The following string values might be valid for this feature:

  • Current0 (Display string: 'Current 0')
  • Current1 (Display string: 'Current 1')
  • Current2 (Display string: 'Current 2')
  • Current3 (Display string: 'Current 3')
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

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