MotorFocusControl Class Reference

Properties for configuring settings belonging to the motor focus control (Device specific interface layout only). More...

Inheritance diagram for MotorFocusControl:

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.
	MotorFocusControl (Device device)
	brief Constructs a new mv.impact.acquire.MotorFocusControl object.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly PropertyI	motorFocusAbsolutePositionCurrent = new PropertyI()
	An integer property (read-only) storing the current absolute position(in encoder counts).
readonly PropertyI	motorFocusAbsolutePositionDesired = new PropertyI()
	An integer property storing an absolute position(in encoder counts) that will be used by subsequent calls to the mv.impact.acquire.MotorFocusControl.motorFocusMoveToAbsolutePositionDesired command.
readonly Method	motorFocusFar = new Method()
	Calling this function will cause the motor focus to move backward by mv.impact.acquire.MotorFocusControl.motorFocusIncrement encoder units.
readonly PropertyI	motorFocusIncrement = new PropertyI()
	An integer property storing an increment(in encoder counts) that will be used by subsequent calls to mv.impact.acquire.MotorFocusControl.motorFocusNear and mv.impact.acquire.MotorFocusControl.motorFocusFar commands.
readonly Method	motorFocusMoveToAbsolutePositionDesired = new Method()
	Calling this function will cause the motor focus to move to the position defined by the value of mv.impact.acquire.MotorFocusControl.motorFocusAbsolutePositionDesired.
readonly Method	motorFocusNear = new Method()
	Calling this function will cause the motor focus to move forward by mv.impact.acquire.MotorFocusControl.motorFocusIncrement encoder units.
readonly PropertyS	motorFocusReceiveBuffer = new PropertyS()
	A string property (read-only) that will contain answers sent by the motor focus controller.
readonly Method	motorFocusSend = new Method()
	Calling this function will send the value of mv.impact.acquire.MotorFocusControl.motorFocusSendBuffer to the hardware.
readonly PropertyS	motorFocusSendBuffer = new PropertyS()
	A string property storing a command to be sent to the motor focus.

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

Properties for configuring settings belonging to the motor focus control (Device specific interface layout only).

Properties in this class will only be available if a device is fitted with a focus motor.

Note

This class will only be available if mv.impact.acquire.Device.interfaceLayout is set to mv.impact.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

MotorFocusControl()

MotorFocusControl ( Device device )

inline

brief Constructs a new mv.impact.acquire.MotorFocusControl object.

Parameters

[in]

device

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

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

motorFocusAbsolutePositionCurrent

readonly PropertyI motorFocusAbsolutePositionCurrent = new PropertyI()

An integer property (read-only) storing the current absolute position(in encoder counts).

motorFocusAbsolutePositionDesired

readonly PropertyI motorFocusAbsolutePositionDesired = new PropertyI()

An integer property storing an absolute position(in encoder counts) that will be used by subsequent calls to the mv.impact.acquire.MotorFocusControl.motorFocusMoveToAbsolutePositionDesired command.

motorFocusFar

readonly Method motorFocusFar = new Method()

Calling this function will cause the motor focus to move backward by mv.impact.acquire.MotorFocusControl.motorFocusIncrement encoder units.

motorFocusIncrement

readonly PropertyI motorFocusIncrement = new PropertyI()

An integer property storing an increment(in encoder counts) that will be used by subsequent calls to mv.impact.acquire.MotorFocusControl.motorFocusNear and mv.impact.acquire.MotorFocusControl.motorFocusFar commands.

motorFocusMoveToAbsolutePositionDesired

readonly Method motorFocusMoveToAbsolutePositionDesired = new Method()

Calling this function will cause the motor focus to move to the position defined by the value of mv.impact.acquire.MotorFocusControl.motorFocusAbsolutePositionDesired.

motorFocusNear

readonly Method motorFocusNear = new Method()

Calling this function will cause the motor focus to move forward by mv.impact.acquire.MotorFocusControl.motorFocusIncrement encoder units.

motorFocusReceiveBuffer

readonly PropertyS motorFocusReceiveBuffer = new PropertyS()

A string property (read-only) that will contain answers sent by the motor focus controller.

motorFocusSend

readonly Method motorFocusSend = new Method()

Calling this function will send the value of mv.impact.acquire.MotorFocusControl.motorFocusSendBuffer to the hardware.

Afterwards mv.impact.acquire.MotorFocusControl.motorFocusReceiveBuffer will contain the hardwares answer.

motorFocusSendBuffer

readonly PropertyS motorFocusSendBuffer = new PropertyS()

A string property storing a command to be sent to the motor focus.

To actually send the command, the function mv.impact.acquire.MotorFocusControl.motorFocusSend must be executed.

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.