mvIMPACT Acquire SDK C++

Category for the Sequencer Control features. More...

#include <mvIMPACT_acquire_GenICam.h>

Public Member Functions

 SequencerControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::SequencerControl object.
 

Public Attributes

PropertyI64 sequencerConfigurationMode
 An enumerated integer property. Controls if the sequencer configuration mode is active.
 
PropertyIBoolean sequencerFeatureEnable
 A boolean property. Enables the selected feature and make it active in all the sequencer sets.
 
PropertyI64 sequencerFeatureSelector
 An enumerated integer property. Selects which sequencer features to control.
 
PropertyI64 sequencerMode
 An enumerated integer property. Controls if the sequencer mechanism is active.
 
PropertyI64 sequencerPathSelector
 An integer property. Selects to which branching path further path settings applies.
 
PropertyI64 sequencerSetActive
 An integer property. Contains the currently active sequencer set.
 
Method sequencerSetLoad
 A method object. Loads the sequencer set selected by SequencerSetSelector in the device.
 
PropertyI64 sequencerSetNext
 An integer property. Specifies the next sequencer set.
 
Method sequencerSetSave
 A method object. Saves the current device state to the sequencer set selected by the SequencerSetSelector.
 
PropertyI64 sequencerSetSelector
 An integer property. Selects the sequencer set to which further feature settings applies.
 
PropertyI64 sequencerSetStart
 An integer property. Sets the initial/start sequencer set, which is the first set used within a sequencer.
 
PropertyI64 sequencerTriggerActivation
 An enumerated integer property. Specifies the activation mode of the sequencer trigger.
 
PropertyI64 sequencerTriggerSource
 An enumerated integer property. Specifies the internal signal or physical input line to use as the sequencer trigger source.
 

Detailed Description

Constructor & Destructor Documentation

◆ SequencerControl()

SequencerControl ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::SequencerControl object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT::acquire::FunctionInterface::getAvailableSettings, new settings can be created with the function mvIMPACT::acquire::FunctionInterface::createSetting

Member Data Documentation

◆ sequencerConfigurationMode

PropertyI64 sequencerConfigurationMode

An enumerated integer property. Controls if the sequencer configuration mode is active.

Controls if the sequencer configuration mode is active.

The following string values might be valid for this feature:

  • On (Display string: 'On'): Enables the sequencer configuration mode.
  • Off (Display string: 'Off'): Disables the sequencer configuration mode.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ sequencerFeatureEnable

PropertyIBoolean sequencerFeatureEnable

A boolean property. Enables the selected feature and make it active in all the sequencer sets.

Enables the selected feature and make it active in all the sequencer sets.

◆ sequencerFeatureSelector

PropertyI64 sequencerFeatureSelector

An enumerated integer property. Selects which sequencer features to control.

Selects which sequencer features to control.

The following string values might be valid for this feature:

  • Device-Specific-Feature-List (Display string: 'Device - Specific - Feature - List'): Device - Specific - Feature - List
  • ExposureTime (Display string: 'Exposure Time')
  • CounterDuration (Display string: 'Counter Duration')
  • mvImagePositionAndSize (Display string: 'mv Image Position And Size'): This value selects whether features affecting the image position and size shall be controlled by the sequencer.
  • Width (Display string: 'Width')
  • Height (Display string: 'Height')
  • OffsetX (Display string: 'Offset X')
  • OffsetY (Display string: 'Offset Y')
  • BinningHorizontal (Display string: 'Binning Horizontal')
  • BinningVertical (Display string: 'Binning Vertical')
  • DecimationHorizontal (Display string: 'Decimation Horizontal')
  • DecimationVertical (Display string: 'Decimation Vertical')
  • Gain (Display string: 'Gain')
  • UserOutputValueAll (Display string: 'User Output Value All')
  • UserOutputValueAllMask (Display string: 'User Output Value All Mask')
  • mvUserOutput (Display string: 'mv User Output'): This value selects whether features affecting the user outputs shall be controlled by the sequencer.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ sequencerMode

PropertyI64 sequencerMode

An enumerated integer property. Controls if the sequencer mechanism is active.

Controls if the sequencer mechanism is active.

The following string values might be valid for this feature:

  • On (Display string: 'On'): Enables the sequencer.
  • Off (Display string: 'Off'): Disables the sequencer.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ sequencerPathSelector

PropertyI64 sequencerPathSelector

An integer property. Selects to which branching path further path settings applies.

Selects to which branching path further path settings applies.

◆ sequencerSetActive

PropertyI64 sequencerSetActive

An integer property. Contains the currently active sequencer set.

Contains the currently active sequencer set.

◆ sequencerSetLoad

Method sequencerSetLoad

A method object. Loads the sequencer set selected by SequencerSetSelector in the device.

Loads the sequencer set selected by SequencerSetSelector in the device. Even if SequencerMode is off, this will change the device state to the configuration of the selected set.

◆ sequencerSetNext

PropertyI64 sequencerSetNext

An integer property. Specifies the next sequencer set.

Specifies the next sequencer set.

◆ sequencerSetSave

Method sequencerSetSave

A method object. Saves the current device state to the sequencer set selected by the SequencerSetSelector.

Saves the current device state to the sequencer set selected by the SequencerSetSelector.

◆ sequencerSetSelector

PropertyI64 sequencerSetSelector

An integer property. Selects the sequencer set to which further feature settings applies.

Selects the sequencer set to which further feature settings applies.

◆ sequencerSetStart

PropertyI64 sequencerSetStart

An integer property. Sets the initial/start sequencer set, which is the first set used within a sequencer.

Sets the initial/start sequencer set, which is the first set used within a sequencer.

◆ sequencerTriggerActivation

PropertyI64 sequencerTriggerActivation

An enumerated integer property. Specifies the activation mode of the sequencer trigger.

Specifies the activation mode of the sequencer trigger.

The following string values might be valid for this feature:

  • RisingEdge (Display string: 'Rising Edge'): Specifies that the trigger is considered valid on the rising edge of the source signal.
  • FallingEdge (Display string: 'Falling Edge'): Specifies that the trigger is considered valid on the falling edge of the source signal.
  • AnyEdge (Display string: 'Any Edge'): Specifies that the trigger is considered valid on the falling or rising edge of the source signal.
  • LevelHigh (Display string: 'Level High'): Specifies that the trigger is considered valid as long as the level of the source signal is high.
  • LevelLow (Display string: 'Level Low'): Specifies that the trigger is considered valid as long as the level of the source signal is low.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ sequencerTriggerSource

PropertyI64 sequencerTriggerSource

An enumerated integer property. Specifies the internal signal or physical input line to use as the sequencer trigger source.

Specifies the internal signal or physical input line to use as the sequencer trigger source.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): Disables the sequencer trigger.
  • AcquisitionTrigger (Display string: 'Acquisition Trigger'): Starts with the reception of the Acquisition Trigger.
  • AcquisitionTriggerMissed (Display string: 'Acquisition Trigger Missed'): Starts with the reception of the missed Acquisition Trigger.
  • AcquisitionStart (Display string: 'Acquisition Start'): Starts with the reception of the Acquisition Start.
  • AcquisitionEnd (Display string: 'Acquisition End'): Starts with the reception of the Acquisition End.
  • FrameTrigger (Display string: 'Frame Trigger'): Starts with the reception of the Frame Start Trigger.
  • FrameTriggerMissed (Display string: 'Frame Trigger Missed'): Starts with the reception of the missed Frame Trigger.
  • FrameStart (Display string: 'Frame Start'): Starts with the reception of the Frame Start.
  • FrameEnd (Display string: 'Frame End'): Starts with the reception of the Frame End.
  • FrameBurstStart (Display string: 'Frame Burst Start'): Starts with the reception of the Frame Burst Start.
  • FrameBurstEnd (Display string: 'Frame Burst End'): Starts with the reception of the Frame Burst End.
  • ExposureStart (Display string: 'Exposure Start'): Starts with the reception of the Exposure Start.
  • ExposureEnd (Display string: 'Exposure End'): Starts with the reception of the Exposure End.
  • Line0 (Display string: 'Line 0'): Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
  • Line1 (Display string: 'Line 1'): Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
  • Line2 (Display string: 'Line 2'): Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
  • Line#3# (Display string: 'Line #3#'): Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
  • UserOutput0 (Display string: 'User Output 0'): Specifies which User Output bit signal to use as internal source for the trigger.
  • UserOutput1 (Display string: 'User Output 1'): Specifies which User Output bit signal to use as internal source for the trigger.
  • UserOutput2 (Display string: 'User Output 2'): Specifies which User Output bit signal to use as internal source for the trigger.
  • UserOutput#3# (Display string: 'User Output #3#'): Specifies which User Output bit signal to use as internal source for the trigger.
  • Counter0Start (Display string: 'Counter 0 Start'): Starts with the reception of the Counter Start.
  • Counter1Start (Display string: 'Counter 1 Start'): Starts with the reception of the Counter Start.
  • Counter2Start (Display string: 'Counter 2 Start'): Starts with the reception of the Counter Start.
  • Counter#3#Start (Display string: 'Counter #3# Start'): Starts with the reception of the Counter Start.
  • Counter0End (Display string: 'Counter 0 End'): Starts with the reception of the Counter End.
  • Counter1End (Display string: 'Counter 1 End'): Starts with the reception of the Counter End.
  • Counter2End (Display string: 'Counter 2 End'): Starts with the reception of the Counter End.
  • Counter#3#End (Display string: 'Counter #3# End'): Starts with the reception of the Counter End.
  • Timer0Start (Display string: 'Timer 0 Start'): Starts with the reception of the Timer Start.
  • Timer1Start (Display string: 'Timer 1 Start'): Starts with the reception of the Timer Start.
  • Timer2Start (Display string: 'Timer 2 Start'): Starts with the reception of the Timer Start.
  • Timer#3#Start (Display string: 'Timer #3# Start'): Starts with the reception of the Timer Start.
  • Timer0End (Display string: 'Timer 0 End'): Starts with the reception of the Timer End.
  • Timer1End (Display string: 'Timer 1 End'): Starts with the reception of the Timer End.
  • Timer2End (Display string: 'Timer 2 End'): Starts with the reception of the Timer End.
  • Timer#3#End (Display string: 'Timer #3# End'): Starts with the reception of the Timer End.
  • Encoder0 (Display string: 'Encoder 0'): Starts with the reception of the Encoder output signal.
  • Encoder1 (Display string: 'Encoder 1'): Starts with the reception of the Encoder output signal.
  • Encoder2 (Display string: 'Encoder 2'): Starts with the reception of the Encoder output signal.
  • Encoder#3# (Display string: 'Encoder #3#'): Starts with the reception of the Encoder output signal.
  • LogicBlock0 (Display string: 'Logic Block 0'): Starts with the reception of the Logic Block output signal.
  • LogicBlock1 (Display string: 'Logic Block 1'): Starts with the reception of the Logic Block output signal.
  • LogicBlock2 (Display string: 'Logic Block 2'): Starts with the reception of the Logic Block output signal.
  • LogicBlock#3# (Display string: 'Logic Block #3#'): Starts with the reception of the Logic Block output signal.
  • SoftwareSignal0 (Display string: 'Software Signal 0'): Starts on the reception of the Software Signal.
  • SoftwareSignal1 (Display string: 'Software Signal 1'): Starts on the reception of the Software Signal.
  • SoftwareSignal2 (Display string: 'Software Signal 2'): Starts on the reception of the Software Signal.
  • SoftwareSignal#3# (Display string: 'Software Signal #3#'): Starts on the reception of the Software Signal.
  • Action0 (Display string: 'Action 0'): Starts with the assertion of the chosen action signal.
  • Action1 (Display string: 'Action 1'): Starts with the assertion of the chosen action signal.
  • Action2 (Display string: 'Action 2'): Starts with the assertion of the chosen action signal.
  • Action#3# (Display string: 'Action #3#'): Starts with the assertion of the chosen action signal.
  • LinkTrigger0 (Display string: 'Link Trigger 0'): Starts with the reception of the chosen Link Trigger.
  • LinkTrigger1 (Display string: 'Link Trigger 1'): Starts with the reception of the chosen Link Trigger.
  • LinkTrigger2 (Display string: 'Link Trigger 2'): Starts with the reception of the chosen Link Trigger.
  • LinkTrigger#3# (Display string: 'Link Trigger #3#'): Starts with the reception of the chosen Link Trigger.
  • CC1 (Display string: 'CC 1'): Index of the Camera Link physical line and associated I/O control block to use. This ensures a direct mapping between the lines on the frame grabber and on the camera. Applicable to CameraLink products only.
  • CC2 (Display string: 'CC 2'): Index of the Camera Link physical line and associated I/O control block to use. This ensures a direct mapping between the lines on the frame grabber and on the camera. Applicable to CameraLink products only.
  • CC3 (Display string: 'CC 3'): Index of the Camera Link physical line and associated I/O control block to use. This ensures a direct mapping between the lines on the frame grabber and on the camera. Applicable to CameraLink products only.
  • CC4 (Display string: 'CC 4'): Index of the Camera Link physical line and associated I/O control block to use. This ensures a direct mapping between the lines on the frame grabber and on the camera. Applicable to CameraLink products only.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.