mvCurrentControl Class Reference

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

Inheritance diagram for mvCurrentControl:

Public Member Functions
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.
IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.
	mvCurrentControl (mv.impact.acquire.Device device)
	Constructs a new mv.impact.acquire.GenICam.mvCurrentControl object.
	mvCurrentControl (mv.impact.acquire.Device device, System.String settingName)
	Constructs a new mv.impact.acquire.GenICam.mvCurrentControl object.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly mv.impact.acquire.PropertyI64	mvCurrent = new mv.impact.acquire.PropertyI64()
	An integer property. Sets the current value for the selected device(e.g.: LED).
readonly mv.impact.acquire.PropertyI64	mvCurrentSelector = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the current source to configure.

Properties
IEnumerable< Component >	componentEnumerable [get]
	Returns an enumerator that iterates through the collection.
IEnumerable< ComponentList >	componentListEnumerable [get]
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.

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/2]

mvCurrentControl ( mv.impact.acquire.Device device )

inline

Constructs a new mv.impact.acquire.GenICam.mvCurrentControl object.

Parameters

[in]

device

A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

mvCurrentControl() [2/2]

mvCurrentControl ( mv.impact.acquire.Device device, System.String settingName )

inline

Constructs a new mv.impact.acquire.GenICam.mvCurrentControl object.

Parameters

[in]	device	A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.
[in]	settingName	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 mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

Member Function Documentation

getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )

inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
  validateProperty(c);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

GetEnumerator()

IEnumerator< int > GetEnumerator ( )

inlineinherited

Returns an enumerator that iterates through the collection.

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

restoreDefault()

void restoreDefault ( )

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.

Member Data Documentation

mvCurrent

readonly mv.impact.acquire.PropertyI64 mvCurrent = new mv.impact.acquire.PropertyI64()

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

readonly mv.impact.acquire.PropertyI64 mvCurrentSelector = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

Property Documentation

componentEnumerable

IEnumerable<Component> componentEnumerable

getinherited

Returns an enumerator that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
  Console.WriteLine("{0}", c.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable

getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
  Console.WriteLine("{0}", cl.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

hObj

int hObj

getinherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mv.impact.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.