Impact Acquire SDK Python
Public Member Functions | Properties
UserSetControl Class Reference
GenICam Interface Layout » GenICam Interface Layout (Device)

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

Inheritance diagram for UserSetControl:
[legend]

Public Member Functions

 __init__ (self, *args)
 Constructs a new mvIMPACT.acquire.UserSetControl object.
 

Properties

 mvUserData = property(lib_mvIMPACT_acquire.UserSetControl_mvUserData_get, doc=)
 A string property.
 
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 userSetDefault = property(lib_mvIMPACT_acquire.UserSetControl_userSetDefault_get, doc=)
 An enumerated integer property.
 
 userSetDefaultSelector = property(lib_mvIMPACT_acquire.UserSetControl_userSetDefaultSelector_get, doc=)
 An enumerated integer property.
 
 userSetDescription = property(lib_mvIMPACT_acquire.UserSetControl_userSetDescription_get, doc=)
 A string property.
 
 userSetFeatureEnable = property(lib_mvIMPACT_acquire.UserSetControl_userSetFeatureEnable_get, doc=)
 A boolean property.
 
 userSetFeatureSelector = property(lib_mvIMPACT_acquire.UserSetControl_userSetFeatureSelector_get, doc=)
 An enumerated integer property.
 
 userSetLoad = property(lib_mvIMPACT_acquire.UserSetControl_userSetLoad_get, doc=)
 A method object.
 
 userSetSave = property(lib_mvIMPACT_acquire.UserSetControl_userSetSave_get, doc=)
 A method object.
 
 userSetSelector = property(lib_mvIMPACT_acquire.UserSetControl_userSetSelector_get, doc=)
 An enumerated integer property.
 

Detailed Description

Category that contains the User Set control features.

A category that contains the User Set control features.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args )

Constructs a new mvIMPACT.acquire.UserSetControl object.

Parameters
pDev[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName[in] The 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

Property Documentation

◆ mvUserData

mvUserData = property(lib_mvIMPACT_acquire.UserSetControl_mvUserData_get, doc=)
static

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 or 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 or mvIMPACT.acquire.PropertyS.readBinary for more details.

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

◆ userSetDefault

userSetDefault = property(lib_mvIMPACT_acquire.UserSetControl_userSetDefault_get, doc=)
static

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.
  • 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.
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.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ userSetDefaultSelector

userSetDefaultSelector = property(lib_mvIMPACT_acquire.UserSetControl_userSetDefaultSelector_get, doc=)
static

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.
  • 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.
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.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ userSetDescription

userSetDescription = property(lib_mvIMPACT_acquire.UserSetControl_userSetDescription_get, doc=)
static

A string property.

Description of the selected User Set content.

Description of the selected User Set content.

◆ userSetFeatureEnable

userSetFeatureEnable = property(lib_mvIMPACT_acquire.UserSetControl_userSetFeatureEnable_get, doc=)
static

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

userSetFeatureSelector = property(lib_mvIMPACT_acquire.UserSetControl_userSetFeatureSelector_get, doc=)
static

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-Feature-List (Display string: 'Device - Specific - Feature - List'): Device - Specific - Feature - List
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.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ userSetLoad

userSetLoad = property(lib_mvIMPACT_acquire.UserSetControl_userSetLoad_get, doc=)
static

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

userSetSave = property(lib_mvIMPACT_acquire.UserSetControl_userSetSave_get, doc=)
static

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

userSetSelector = property(lib_mvIMPACT_acquire.UserSetControl_userSetSelector_get, doc=)
static

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.
  • 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.
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.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.