mvCurrentControl Class Reference

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

Inheritance diagram for mvCurrentControl:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.mvCurrentControl object.
	hObj (self)
	Returns a unique identifier for the component collection referenced by this object.
	restoreDefault (self)
	Restores the default for every component of this collection.

Properties
	mvCurrent = property(lib_mvIMPACT_acquire.mvCurrentControl_mvCurrent_get, doc=)
	An integer property.
	mvCurrentSelector = property(lib_mvIMPACT_acquire.mvCurrentControl_mvCurrentSelector_get, doc=)
	An enumerated integer property.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

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

__init__()

__init__	(		self,
		*	args )

Constructs a new mvIMPACT.acquire.mvCurrentControl 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

Member Function Documentation

hObj()

hObj ( self )

inherited

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

restoreDefault ( self )

inherited

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.

Property Documentation

mvCurrent

mvCurrent = property(lib_mvIMPACT_acquire.mvCurrentControl_mvCurrent_get, doc=)

static

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

mvCurrentSelector = property(lib_mvIMPACT_acquire.mvCurrentControl_mvCurrentSelector_get, doc=)

static

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

thisown

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

static