mvIMPACT Acquire SDK C++
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:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI address
 An integer property, which defines the absolute jump address within this mvIMPACT::acquire::RTCtrProgram. More...
 
PropertyI clocks_us
 An integer property, which defines the waiting time mvIMPACT::acquire::RTCtrProgram. More...
 
PropertyI controllerRegister
 An integer property, which defines the index of the controller register to refer in this mvIMPACT::acquire::RTCtrProgramStep. More...
 
PropertyIDigIOState digitalInputs
 An enumerated integer property to define for which digital input state this program step waits for. More...
 
PropertyIDigIOState digitalOutputs
 An enumerated integer property to define how to set the digital outputs of this device. More...
 
PropertyI frameID
 An integer property, which defines the frame ID of the triggered image mvIMPACT::acquire::RTCtrProgram. More...
 
PropertyIRTProgOpCodes opCode
 An enumerated integer property defining the general purpose of this mvIMPACT::acquire::RTCtrProgramStep object. More...
 
PropertyI registerValue
 An integer property, which defines the a value to associate with a register access in this mvIMPACT::acquire::RTCtrProgramStep. More...
 
PropertyIDigIOState sensorHeads
 An enumerated integer property to define which sensor heads to trigger (for devices with more than one sensor head). More...
 

Protected Attributes

HOBJ m_hRoot
 

Friends

class RTCtrProgram
 

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.

Member Function Documentation

◆ hObj()

HOBJ hObj ( void  ) const
inlineinherited

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

const ComponentCollection& restoreDefault ( void  ) const
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.
Returns
A const reference to the component.

Friends And Related Function Documentation

◆ RTCtrProgram

friend class RTCtrProgram
friend

Member Data Documentation

◆ address

PropertyI address

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

PropertyI clocks_us

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

◆ digitalInputs

PropertyIDigIOState digitalInputs

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

◆ digitalOutputs

PropertyIDigIOState digitalOutputs

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

◆ frameID

PropertyI frameID

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.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ opCode

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.

◆ registerValue

PropertyI registerValue

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. C++ offers the more efficient function mvIMPACT::acquire::PropertyIPulseStartTrigger::getTranslationDict in addition to the functions mentioned above.

◆ sensorHeads

PropertyIDigIOState sensorHeads

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


The documentation for this class was generated from the following file: