mvIMPACT Acquire SDK C++

Category that contains the User Set control features. More...

Public Member Functions

 UserSetControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::UserSetControl object. More...
 

Public Attributes

PropertyS mvUserData
 A string property. A register to store arbitrary user data into the devices non-volatile memory. The data is stored as binary data encoded in Base64 see mvIMPACT::acquire::PropertyS::writeBinary/mvIMPACT::acquire::PropertyS::readBinary for more details. More...
 
PropertyI64 userSetDefault
 An enumerated integer property. Selects the feature User Set to load and make active by default when the device is reset. More...
 
PropertyI64 userSetDefaultSelector
 An enumerated integer property. This feature is deprecated (See UserSetDefault). More...
 
PropertyS userSetDescription
 A string property. Description of the selected User Set content. More...
 
PropertyIBoolean userSetFeatureEnable
 A boolean property. Enables the selected feature and make it active in all the UserSets. More...
 
PropertyI64 userSetFeatureSelector
 An enumerated integer property. Selects which individual UserSet feature to control. More...
 
Method userSetLoad
 A method object. Loads the User Set specified by UserSetSelector to the device and makes it active. More...
 
Method userSetSave
 A method object. Save the User Set specified by UserSetSelector to the non-volatile memory of the device. More...
 
PropertyI64 userSetSelector
 An enumerated integer property. Selects the feature User Set to load, save or configure. More...
 

Detailed Description

Category that contains the User Set control features.

A category that contains the User Set control features.

Examples
GenICamCommonSettingsUsage.cpp, and GenICamCommonSettingsUsage.legacy.cpp.

Constructor & Destructor Documentation

◆ UserSetControl()

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

Constructs a new mvIMPACT::acquire::GenICam::UserSetControl 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 Data Documentation

◆ mvUserData

PropertyS mvUserData

A string property. A register to store arbitrary user data into the devices non-volatile memory. The data is stored as binary data encoded in Base64 see mvIMPACT::acquire::PropertyS::writeBinary/mvIMPACT::acquire::PropertyS::readBinary for more details.

A register to store arbitrary user data into the devices non-volatile memory. The data is stored as binary data encoded in Base64 see mvIMPACT::acquire::PropertyS::writeBinary/mvIMPACT::acquire::PropertyS::readBinary for more details.

◆ userSetDefault

PropertyI64 userSetDefault

An enumerated integer property. Selects the feature User Set to load and make active by default when the device is reset.

Selects the feature User Set to load and make active by default when the device is reset.

The following string values might be valid for this feature:

  • Default (Display string: 'Default'): Select the factory setting user set.
  • UserSet0 (Display string: 'User Set 0'): Select the user set 0.
  • UserSet1 (Display string: 'User Set 1'): Select the user set 1.
  • UserSet#2# (Display string: 'User Set #2#'): Select the user set #2#.
  • UserSet2 (Display string: 'User Set 2'): Select the user set 2.
  • UserSet3 (Display string: 'User Set 3'): Select the user set 3.
  • UserSet4 (Display string: 'User Set 4'): Select the user set 4.
  • UserSet5 (Display string: 'User Set 5'): Select the user set 5.
  • UserSet6 (Display string: 'User Set 6'): Select the user set 6.
  • UserSet7 (Display string: 'User Set 7'): Select the user set 7.
  • UserSet8 (Display string: 'User Set 8'): Select the user set 8.
  • UserSet9 (Display string: 'User Set 9'): Select the user set 9.
  • UserSet10 (Display string: 'User Set 10'): Select the user set 10.
  • UserSet11 (Display string: 'User Set 11'): Select the user set 11.
  • UserSet12 (Display string: 'User Set 12'): Select the user set 12.
  • UserSet13 (Display string: 'User Set 13'): Select the user set 13.
  • UserSet14 (Display string: 'User Set 14'): Select the user set 14.
  • UserSet15 (Display string: 'User Set 15'): Select the user set 15.
  • UserSet16 (Display string: 'User Set 16')
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.

◆ userSetDefaultSelector

PropertyI64 userSetDefaultSelector

An enumerated integer property. This feature is deprecated (See UserSetDefault).

Deprecated:
This feature is deprecated (See UserSetDefault). Selects the feature User Set to load and make active when the device is reset.

The following string values might be valid for this feature:

  • Default (Display string: 'Default'): Select the factory setting user set.
  • UserSet0 (Display string: 'User Set 0'): Select the user set 0.
  • UserSet1 (Display string: 'User Set 1'): Select the user set 1.
  • UserSet#2# (Display string: 'User Set #2#'): Select the user set #2#.
  • UserSet2 (Display string: 'User Set 2'): Select the user set 2.
  • UserSet3 (Display string: 'User Set 3'): Select the user set 3.
  • UserSet4 (Display string: 'User Set 4'): Select the user set 4.
  • UserSet5 (Display string: 'User Set 5'): Select the user set 5.
  • UserSet6 (Display string: 'User Set 6'): Select the user set 6.
  • UserSet7 (Display string: 'User Set 7'): Select the user set 7.
  • UserSet8 (Display string: 'User Set 8'): Select the user set 8.
  • UserSet9 (Display string: 'User Set 9'): Select the user set 9.
  • UserSet10 (Display string: 'User Set 10'): Select the user set 10.
  • UserSet11 (Display string: 'User Set 11'): Select the user set 11.
  • UserSet12 (Display string: 'User Set 12'): Select the user set 12.
  • UserSet13 (Display string: 'User Set 13'): Select the user set 13.
  • UserSet14 (Display string: 'User Set 14'): Select the user set 14.
  • UserSet15 (Display string: 'User Set 15'): Select the user set 15.
  • UserSet16 (Display string: 'User Set 16')
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.

◆ userSetDescription

PropertyS userSetDescription

A string property. Description of the selected User Set content.

Description of the selected User Set content.

◆ userSetFeatureEnable

PropertyIBoolean userSetFeatureEnable

A boolean property. Enables the selected feature and make it active in all the UserSets.

Enables the selected feature and make it active in all the UserSets.

◆ userSetFeatureSelector

PropertyI64 userSetFeatureSelector

An enumerated integer property. Selects which individual UserSet feature to control.

Selects which individual UserSet feature to control.

The following string values might be valid for this feature:

  • Device-Specific (Display string: 'Device - Specific'): Device - Specific
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.

◆ userSetLoad

Method userSetLoad

A method object. Loads the User Set specified by UserSetSelector to the device and makes it active.

Loads the User Set specified by UserSetSelector to the device and makes it active.

◆ userSetSave

Method userSetSave

A method object. Save the User Set specified by UserSetSelector to the non-volatile memory of the device.

Save the User Set specified by UserSetSelector to the non-volatile memory of the device.

◆ userSetSelector

PropertyI64 userSetSelector

An enumerated integer property. Selects the feature User Set to load, save or configure.

Selects the feature User Set to load, save or configure.

The following string values might be valid for this feature:

  • Default (Display string: 'Default'): Selects the factory setting user set.
  • UserSet0 (Display string: 'User Set 0'): Selects the user set 0.
  • UserSet1 (Display string: 'User Set 1'): Selects the user set 1.
  • UserSet#2# (Display string: 'User Set #2#'): Selects the user set #2#.
  • UserSet2 (Display string: 'User Set 2'): Selects the user set 2.
  • UserSet3 (Display string: 'User Set 3'): Selects the user set 3.
  • UserSet4 (Display string: 'User Set 4'): Selects the user set 4.
  • UserSet5 (Display string: 'User Set 5'): Selects the user set 5.
  • UserSet6 (Display string: 'User Set 6'): Selects the user set 6.
  • UserSet7 (Display string: 'User Set 7'): Selects the user set 7.
  • UserSet8 (Display string: 'User Set 8'): Selects the user set 8.
  • UserSet9 (Display string: 'User Set 9'): Selects the user set 9.
  • UserSet10 (Display string: 'User Set 10'): Selects the user set 10.
  • UserSet11 (Display string: 'User Set 11'): Selects the user set 11.
  • UserSet12 (Display string: 'User Set 12'): Selects the user set 12.
  • UserSet13 (Display string: 'User Set 13'): Selects the user set 13.
  • UserSet14 (Display string: 'User Set 14'): Selects the user set 14.
  • UserSet15 (Display string: 'User Set 15'): Selects the user set 15.
  • UserSet16 (Display string: 'User Set 16')
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: