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

Inheritance diagram for mvCurrentControl:

Public Member Functions
synchronized void	delete ()

PropertyI64	getMvCurrent ()
	An integer property.

PropertyI64	getMvCurrentSelector ()
	An enumerated integer property.

int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.

	mvCurrentControl (Device pDev)
	Constructs a new mvIMPACT.acquire.mvCurrentControl object.

	mvCurrentControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.mvCurrentControl object.

ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()

	mvCurrentControl (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)

static long	swigRelease (mvCurrentControl obj)

Protected Attributes
transient boolean	swigCMemOwn

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() [1/3]

mvCurrentControl	(	long	cPtr,
		boolean	cMemoryOwn )

protected

◆ mvCurrentControl() [2/3]

mvCurrentControl	(	Device	pDev,
		String	settingName )

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

◆ mvCurrentControl() [3/3]

mvCurrentControl ( Device pDev )

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

◆ delete()

synchronized void delete ( )

Reimplemented from ComponentCollection.

◆ finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

◆ getMvCurrent()

PropertyI64 getMvCurrent ( )

An integer property.

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

◆ getMvCurrentSelector()

PropertyI64 getMvCurrentSelector ( )

An enumerated integer property.

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.

◆ hObj()

int hObj ( )

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

ComponentCollection restoreDefault ( )

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.

◆ swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

◆ swigRelease() [2/2]

static long swigRelease ( mvCurrentControl obj )

staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn

protectedinherited

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes