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
synchronized void	delete ()
PropertyI	getMotorFocusAbsolutePositionCurrent ()
	An integer property (read-only) storing the current absolute position(in encoder counts).
PropertyI	getMotorFocusAbsolutePositionDesired ()
	An integer property storing an absolute position(in encoder counts) that will be used by subsequent calls to the mvIMPACT.acquire.MotorFocusControl.motorFocusMoveToAbsolutePositionDesired command.
Method	getMotorFocusFar ()
	Calling this function will cause the motor focus to move backward by mvIMPACT.acquire.MotorFocusControl.getMotorFocusIncrement() encoder units.
PropertyI	getMotorFocusIncrement ()
	An integer property storing an increment(in encoder counts) that will be used by subsequent calls to mvIMPACT.acquire.MotorFocusControl.motorFocusNear and mvIMPACT.acquire.MotorFocusControl.motorFocusFar commands.
Method	getMotorFocusMoveToAbsolutePositionDesired ()
	Calling this function will cause the motor focus to move to the position defined by the value of mvIMPACT.acquire.MotorFocusControl.getMotorFocusAbsolutePositionDesired().
Method	getMotorFocusNear ()
	Calling this function will cause the motor focus to move forward by mvIMPACT.acquire.MotorFocusControl.getMotorFocusIncrement() encoder units.
PropertyS	getMotorFocusReceiveBuffer ()
	A string property (read-only) that will contain answers sent by the motor focus controller.
Method	getMotorFocusSend ()
	Calling this function will send the value of mvIMPACT.acquire.MotorFocusControl.getMotorFocusSendBuffer() to the hardware.
PropertyS	getMotorFocusSendBuffer ()
	A string property storing a command to be sent to the motor focus.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
	MotorFocusControl (Device pDev)
	brief Constructs a new mvIMPACT.acquire.MotorFocusControl object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()
	MotorFocusControl (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (MotorFocusControl obj)

Protected Attributes
transient boolean	swigCMemOwn

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 mvIMPACT.acquire.Device.getInterfaceLayout() is set to mvIMPACT.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

MotorFocusControl() [1/2]

MotorFocusControl ( long cPtr, boolean cMemoryOwn )

protected

MotorFocusControl() [2/2]

MotorFocusControl

(

Device

pDev

)

brief Constructs a new mvIMPACT.acquire.MotorFocusControl object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getMotorFocusAbsolutePositionCurrent()

PropertyI getMotorFocusAbsolutePositionCurrent

(

)

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

getMotorFocusAbsolutePositionDesired()

PropertyI getMotorFocusAbsolutePositionDesired

(

)

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

getMotorFocusFar()

Method getMotorFocusFar

(

)

Calling this function will cause the motor focus to move backward by mvIMPACT.acquire.MotorFocusControl.getMotorFocusIncrement() encoder units.

getMotorFocusIncrement()

PropertyI getMotorFocusIncrement

(

)

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

getMotorFocusMoveToAbsolutePositionDesired()

Method getMotorFocusMoveToAbsolutePositionDesired

(

)

Calling this function will cause the motor focus to move to the position defined by the value of mvIMPACT.acquire.MotorFocusControl.getMotorFocusAbsolutePositionDesired().

getMotorFocusNear()

Method getMotorFocusNear

(

)

Calling this function will cause the motor focus to move forward by mvIMPACT.acquire.MotorFocusControl.getMotorFocusIncrement() encoder units.

getMotorFocusReceiveBuffer()

PropertyS getMotorFocusReceiveBuffer

(

)

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

getMotorFocusSend()

Method getMotorFocusSend

(

)

Calling this function will send the value of mvIMPACT.acquire.MotorFocusControl.getMotorFocusSendBuffer() to the hardware.

Afterwards mvIMPACT.acquire.MotorFocusControl.getMotorFocusReceiveBuffer() will contain the hardwares answer.

getMotorFocusSendBuffer()

PropertyS getMotorFocusSendBuffer

(

)

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

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

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

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited