Impact Acquire SDK Python
Public Member Functions | Properties
RTCtrProgramStep Class Reference
Device Specific Interface Layout

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

Inheritance diagram for RTCtrProgramStep:
[legend]

Public Member Functions

 __init__ (self, *args, **kwargs)
 

Properties

 address = property(lib_mvIMPACT_acquire.RTCtrProgramStep_address_get, doc=)
 An integer property, which defines the absolute jump address within this mvIMPACT.acquire.RTCtrProgram.
 
 clocks_us = property(lib_mvIMPACT_acquire.RTCtrProgramStep_clocks_us_get, doc=)
 An integer property, which defines the waiting time mvIMPACT.acquire.RTCtrProgram.
 
 controllerRegister = property(lib_mvIMPACT_acquire.RTCtrProgramStep_controllerRegister_get, doc=)
 An integer property, which defines the index of the controller register to refer in this mvIMPACT.acquire.RTCtrProgramStep.
 
 digitalInputs = property(lib_mvIMPACT_acquire.RTCtrProgramStep_digitalInputs_get, doc=)
 An enumerated integer property to define for which digital input state this program step waits for.
 
 digitalOutputs = property(lib_mvIMPACT_acquire.RTCtrProgramStep_digitalOutputs_get, doc=)
 An enumerated integer property to define how to set the digital outputs of this device.
 
 frameID = property(lib_mvIMPACT_acquire.RTCtrProgramStep_frameID_get, doc=)
 An integer property, which defines the frame ID of the triggered image mvIMPACT.acquire.RTCtrProgram.
 
 opCode = property(lib_mvIMPACT_acquire.RTCtrProgramStep_opCode_get, doc=)
 An enumerated integer property defining the general purpose of this mvIMPACT.acquire.RTCtrProgramStep object.
 
 registerValue = property(lib_mvIMPACT_acquire.RTCtrProgramStep_registerValue_get, doc=)
 An integer property, which defines the a value to associate with a register access in this mvIMPACT.acquire.RTCtrProgramStep.
 
 sensorHeads = property(lib_mvIMPACT_acquire.RTCtrProgramStep_sensorHeads_get, doc=)
 An enumerated integer property to define which sensor heads to trigger (for devices with more than one sensor head).
 
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

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.opCode. 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.interfaceLayout is set to mvIMPACT.acquire.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args,
** kwargs )

Reimplemented from ComponentCollection.

Property Documentation

◆ address

address = property(lib_mvIMPACT_acquire.RTCtrProgramStep_address_get, doc=)
static

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.opCode is set to mvIMPACT.acquire.rtctrlProgJumpLoc.

◆ clocks_us

clocks_us = property(lib_mvIMPACT_acquire.RTCtrProgramStep_clocks_us_get, doc=)
static

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

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.opCode is set to mvIMPACT.acquire.rtctrlProgWaitClocks.

◆ controllerRegister

controllerRegister = property(lib_mvIMPACT_acquire.RTCtrProgramStep_controllerRegister_get, doc=)
static

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.opCode is set to mvIMPACT.acquire.rtctrlProgRegisterSet, mvIMPACT.acquire.rtctrlProgRegisterAdd, mvIMPACT.acquire.rtctrlProgRegisterSub, mvIMPACT.acquire.rtctrlProgJumpLocOnZero or mvIMPACT.acquire.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.opCode contains mvIMPACT.acquire.rtctrlProgRegisterSet, mvIMPACT.acquire.rtctrlProgRegisterAdd, mvIMPACT.acquire.rtctrlProgRegisterSub, mvIMPACT.acquire.rtctrlProgJumpLocOnZero or mvIMPACT.acquire.rtctrlProgJumpLocOnNotZero.

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

◆ digitalInputs

digitalInputs = property(lib_mvIMPACT_acquire.RTCtrProgramStep_digitalInputs_get, doc=)
static

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

Valid values for this property may be: mvIMPACT.acquire.digioOff, mvIMPACT.acquire.digioOn, mvIMPACT.acquire.digioIgnore, mvIMPACT.acquire.digioKeep.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.opCode is set to mvIMPACT.acquire.rtctrlProgWaitDigin.

◆ digitalOutputs

digitalOutputs = property(lib_mvIMPACT_acquire.RTCtrProgramStep_digitalOutputs_get, doc=)
static

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

Valid values for this property may be: mvIMPACT.acquire.digioOff, mvIMPACT.acquire.digioOn, mvIMPACT.acquire.digioIgnore, mvIMPACT.acquire.digioKeep.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.opCode is set to mvIMPACT.acquire.rtctrlProgSetDigout.

◆ frameID

frameID = property(lib_mvIMPACT_acquire.RTCtrProgramStep_frameID_get, doc=)
static

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.opCode is set to mvIMPACT.acquire.rtctrlProgTriggerSet.

◆ opCode

opCode = property(lib_mvIMPACT_acquire.RTCtrProgramStep_opCode_get, doc=)
static

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

Valid values for this property may be: mvIMPACT.acquire.rtctrlProgNop, mvIMPACT.acquire.rtctrlProgSetDigout, mvIMPACT.acquire.rtctrlProgWaitDigin, mvIMPACT.acquire.rtctrlProgWaitClocks, mvIMPACT.acquire.rtctrlProgJumpLoc, mvIMPACT.acquire.rtctrlProgTriggerSet, mvIMPACT.acquire.rtctrlProgTriggerReset, mvIMPACT.acquire.rtctrlProgExposeSet, mvIMPACT.acquire.rtctrlProgExposeReset, mvIMPACT.acquire.rtctrlProgFrameNrReset, mvIMPACT.acquire.rtctrlProgJumpLocOnZero, mvIMPACT.acquire.rtctrlProgJumpLocOnNotZero, mvIMPACT.acquire.rtctrlProgRegisterSet, mvIMPACT.acquire.rtctrlProgRegisterAdd, mvIMPACT.acquire.rtctrlProgRegisterSub.

◆ registerValue

registerValue = property(lib_mvIMPACT_acquire.RTCtrProgramStep_registerValue_get, doc=)
static

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.opCode is set to mvIMPACT.acquire.rtctrlProgRegisterSet, mvIMPACT.acquire.rtctrlProgRegisterAdd or mvIMPACT.acquire.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.opCode contains mvIMPACT.acquire.rtctrlProgRegisterSet, mvIMPACT.acquire.rtctrlProgRegisterAdd, or mvIMPACT.acquire.rtctrlProgRegisterSub.

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

◆ sensorHeads

sensorHeads = property(lib_mvIMPACT_acquire.RTCtrProgramStep_sensorHeads_get, doc=)
static

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

Valid values for this property may be: mvIMPACT.acquire.digioOff, mvIMPACT.acquire.digioOn, mvIMPACT.acquire.digioIgnore, mvIMPACT.acquire.digioKeep.

This property only is taken into account, if mvIMPACT.acquire.RTCtrProgramStep.opCode is set to mvIMPACT.acquire.rtctrlProgTriggerSet or mvIMPACT.acquire.rtctrlProgTriggerReset.

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static