RTCtrProgramStep Class Reference

A class to represent one step of a real time control(RTCtr) program (Device specific interface layout only). More...

Inheritance diagram for RTCtrProgramStep:

Public Member Functions
synchronized void	delete ()
PropertyI	getAddress ()
	An integer property, which defines the absolute jump address within this mvIMPACT.acquire.RTCtrProgram.
PropertyI	getClocks_us ()
	An integer property, which defines the waiting time mvIMPACT.acquire.RTCtrProgram.
PropertyI	getControllerRegister ()
	An integer property, which defines the index of the controller register to refer in this mvIMPACT.acquire.RTCtrProgramStep.
PropertyI	getDigitalInputs ()
	An enumerated integer property to define for which digital input state this program step waits for.
PropertyI	getDigitalOutputs ()
	An enumerated integer property to define how to set the digital outputs of this device.
PropertyI	getFrameID ()
	An integer property, which defines the frame ID of the triggered image mvIMPACT.acquire.RTCtrProgram.
PropertyI	getOpCode ()
	An enumerated integer property defining the general purpose of this mvIMPACT.acquire.RTCtrProgramStep object.
PropertyI	getRegisterValue ()
	An integer property, which defines the a value to associate with a register access in this mvIMPACT.acquire.RTCtrProgramStep.
PropertyI	getSensorHeads ()
	An enumerated integer property to define which sensor heads to trigger (for devices with more than one sensor head).
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

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

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

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

A class to represent one step of a real time control(RTCtr) program (Device specific interface layout only).

An object of this class represents a single instruction in a program represented by an mvIMPACT.acquire.RTCtrProgram. mvIMPACT.acquire.RTCtrProgramStep object can't be constructed directly, but must be accessed via the function mvIMPACT.acquire.RTCtrProgram.programStep of the program they belong to.

The instruction this mvIMPACT.acquire.RTCtrProgramStep will executed when the program is executed is defined by the property mvIMPACT.acquire.RTCtrProgramStep.getOpCode(). Depending on the value of this property certain other parameters will influence the behaviour of this instruction.

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

RTCtrProgramStep()

RTCtrProgramStep ( long cPtr, boolean cMemoryOwn )

protected

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getAddress()

PropertyI getAddress

(

)

An integer property, which defines the absolute jump address within this mvIMPACT.acquire.RTCtrProgram.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.getOpCode() is set to mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgJumpLoc.

getClocks_us()

PropertyI getClocks_us

(

)

An integer property, which defines the waiting time mvIMPACT.acquire.RTCtrProgram.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.getOpCode() is set to mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgWaitClocks.

getControllerRegister()

PropertyI getControllerRegister

(

)

An integer property, which defines the index of the controller register to refer in this mvIMPACT.acquire.RTCtrProgramStep.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.getOpCode() is set to mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterSet, mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterAdd, mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterSub, mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgJumpLocOnZero or mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgJumpLocOnNotZero.

Note

This feature will not be available for every device offering a HRTC. It will be available if the translation dictionary of the property mvIMPACT.acquire.RTCtrProgramStep.getOpCode() contains mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterSet, mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterAdd, mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterSub, mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgJumpLocOnZero or mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgJumpLocOnNotZero.

Read the properties translation dictionary with the functions mvIMPACT.acquire.PropertyIPulseStartTrigger.getTranslationDictString and mvIMPACT.acquire.PropertyIPulseStartTrigger.getTranslationDictValue.

getDigitalInputs()

PropertyI getDigitalInputs

(

)

An enumerated integer property to define for which digital input state this program step waits for.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TDigIOState.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.getOpCode() is set to mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgWaitDigin.

getDigitalOutputs()

PropertyI getDigitalOutputs

(

)

An enumerated integer property to define how to set the digital outputs of this device.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TDigIOState.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.getOpCode() is set to mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgSetDigout.

getFrameID()

PropertyI getFrameID

(

)

An integer property, which defines the frame ID of the triggered image mvIMPACT.acquire.RTCtrProgram.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.getOpCode() is set to mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgTriggerSet.

getOpCode()

PropertyI getOpCode

(

)

An enumerated integer property defining the general purpose of this mvIMPACT.acquire.RTCtrProgramStep object.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TRTProgOpCodes.

getRegisterValue()

PropertyI getRegisterValue

(

)

An integer property, which defines the a value to associate with a register access in this mvIMPACT.acquire.RTCtrProgramStep.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.getOpCode() is set to mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterSet, mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterAdd or mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterSub.

Note

This feature will not be available for every device offering a HRTC. It will be available if the translation dictionary of the property mvIMPACT.acquire.RTCtrProgramStep.getOpCode() contains mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterSet, mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterAdd, or mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgRegisterSub.

Read the properties translation dictionary with the functions mvIMPACT.acquire.PropertyIPulseStartTrigger.getTranslationDictString and mvIMPACT.acquire.PropertyIPulseStartTrigger.getTranslationDictValue.

getSensorHeads()

PropertyI getSensorHeads

(

)

An enumerated integer property to define which sensor heads to trigger (for devices with more than one sensor head).

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TDigIOState.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.getOpCode() is set to mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgTriggerSet or mvIMPACT.acquire.TRTProgOpCodes.rtctrlProgTriggerReset.

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

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited