mvLensControl Class Reference

Contains features to control motorized lenses. More...

Inheritance diagram for mvLensControl:

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.
	mvLensControl (mv.impact.acquire.Device device)
	Constructs a new mv.impact.acquire.GenICam.mvLensControl object.
	mvLensControl (mv.impact.acquire.Device device, System.String settingName)
	Constructs a new mv.impact.acquire.GenICam.mvLensControl object.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly mv.impact.acquire.Method	mvDriveBackward = new mv.impact.acquire.Method()
	A method object. Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in backward direction.
readonly mv.impact.acquire.PropertyI64	mvDriveDuration = new mv.impact.acquire.PropertyI64()
	An integer property. Sets the duration of the drive command in us.
readonly mv.impact.acquire.Method	mvDriveForward = new mv.impact.acquire.Method()
	A method object. Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in forward direction.
readonly mv.impact.acquire.PropertyI64	mvDriveLevel = new mv.impact.acquire.PropertyI64()
	An integer property. Sets the voltage level of the drive command in mV.
readonly mv.impact.acquire.PropertyI64	mvDriveSelector = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the lens drive that should be adjusted.
readonly mv.impact.acquire.PropertyI64	mvIrisMode = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Sets the iris operating mode.
readonly mv.impact.acquire.PropertyI64	mvIrisSignalLevelMax = new mv.impact.acquire.PropertyI64()
	An integer property. Sets the maximum iris signal level in mV.
readonly mv.impact.acquire.PropertyI64	mvIrisSignalLevelMin = new mv.impact.acquire.PropertyI64()
	An integer property. Sets the minimum iris signal level in mV.
readonly mv.impact.acquire.PropertyI64	mvIrisType = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Sets the iris type.

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

Contains features to control motorized lenses.

Contains features to control motorized lenses.

Constructor & Destructor Documentation

mvLensControl() [1/2]

mvLensControl ( mv::impact::acquire::Device device )

inline

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

Parameters

[in]

device

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

mvLensControl() [2/2]

mvLensControl ( mv::impact::acquire::Device device, System::String settingName )

inline

Constructs a new mv.impact.acquire.GenICam.mvLensControl 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

mvDriveBackward

readonly mv.impact.acquire.Method mvDriveBackward = new mv.impact.acquire.Method()

A method object. Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in backward direction.

Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in backward direction.

mvDriveDuration

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

An integer property. Sets the duration of the drive command in us.

Sets the duration of the drive command in us.

mvDriveForward

readonly mv.impact.acquire.Method mvDriveForward = new mv.impact.acquire.Method()

A method object. Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in forward direction.

Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in forward direction.

mvDriveLevel

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

An integer property. Sets the voltage level of the drive command in mV.

Sets the voltage level of the drive command in mV.

mvDriveSelector

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

An enumerated integer property. Selects the lens drive that should be adjusted.

Selects the lens drive that should be adjusted.

The following string values might be valid for this feature:

• mvFocus (Display string: 'mv Focus'): Selects the motor to control the focus.
• mvZoom (Display string: 'mv Zoom'): Selects the motor to control the zoom.
• mvIris (Display string: 'mv Iris'): Selects the motor to control the iris.

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.

mvIrisMode

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

An enumerated integer property. Sets the iris operating mode.

Sets the iris operating mode.

The following string values might be valid for this feature:

• Off (Display string: 'Off'): No iris adjustment will be done.
• mvIrisAuto (Display string: 'mv Iris Auto'): The iris adjustment will be done automatically by evaluating the current image data.
• mvIrisOpen (Display string: 'mv Iris Open'): The iris is fully open.
• mvIrisClose (Display string: 'mv Iris Close'): The iris is fully closed.

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.

mvIrisSignalLevelMax

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

An integer property. Sets the maximum iris signal level in mV.

Sets the maximum iris signal level in mV.

mvIrisSignalLevelMin

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

An integer property. Sets the minimum iris signal level in mV.

Sets the minimum iris signal level in mV.

mvIrisType

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

An enumerated integer property. Sets the iris type.

Sets the iris type.

The following string values might be valid for this feature:

• mvVideoIris (Display string: 'mv Video Iris')

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.