mvIMPACT Acquire SDK C++
TriggerControl Class Reference

A class to configure the behaviour of trigger signals. More...

Inheritance diagram for TriggerControl:
ComponentCollection

Public Member Functions

std::string getDescription (void) const
 Returns a name of the trigger being configured. More...
 
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...
 
int triggerSoftware (void) const
 Generates of software trigger command. More...
 

Public Attributes

PropertyI64 triggerActivation
 An enumerated 64 bit integer property that defines the start condition for the selected trigger. More...
 
PropertyF triggerDelayAbs_us
 Specifies the absolute delay in microseconds (us) to apply after the trigger reception before effectively activating it. More...
 
PropertyI triggerDelayLines
 Specifies the absolute delay in lines to apply after the trigger reception before effectively activating it. More...
 
PropertyI triggerDivider
 An integer property used to divide the number of incoming trigger pulses by an integer factor. More...
 
PropertyI64 triggerMode
 Defines if the selected trigger is active. More...
 
PropertyI64DeviceTriggerOverlap triggerOverlap
 Specifies the type trigger overlap permitted with the previous frame. More...
 
PropertyI64 triggerSource
 Defines the signal that will cause the trigger event. More...
 

Protected Attributes

HOBJ m_hRoot
 

Friends

class CameraSettingsBlueCOUGAR
 
class CameraSettingsFrameGrabber
 

Detailed Description

A class to configure the behaviour of trigger signals.

Features in this class will open up a more flexible way to configure certain trigger events for devices then the previous features('triggerInterface', 'triggerSource' and 'triggerMode' used.

Note
Not ever device will support every property listed in this class for every trigger mode. Always call mvIMPACT::acquire::Component::isValid to check whether a feature is available or not before using it. Otherwise an exception will be generated.

Member Function Documentation

◆ getDescription()

std::string getDescription ( void  ) const
inline

Returns a name of the trigger being configured.

◆ 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.

◆ triggerSoftware()

int triggerSoftware ( void  ) const
inline

Generates of software trigger command.

Returns

Friends And Related Function Documentation

◆ CameraSettingsBlueCOUGAR

friend class CameraSettingsBlueCOUGAR
friend

◆ CameraSettingsFrameGrabber

friend class CameraSettingsFrameGrabber
friend

Member Data Documentation

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ triggerActivation

PropertyI64 triggerActivation

An enumerated 64 bit integer property that defines the start condition for the selected trigger.

Valid value will be 'RisingEdge', 'FallingEdge', 'AnyEdge', 'LevelLow' or 'LevelHigh'.

◆ triggerDelayAbs_us

PropertyF triggerDelayAbs_us

Specifies the absolute delay in microseconds (us) to apply after the trigger reception before effectively activating it.

◆ triggerDelayLines

PropertyI triggerDelayLines

Specifies the absolute delay in lines to apply after the trigger reception before effectively activating it.

◆ triggerDivider

PropertyI triggerDivider

An integer property used to divide the number of incoming trigger pulses by an integer factor.

E.g. setting this value to 2 would generate 5 internal trigger events from a 10 Hz external signal.

◆ triggerMode

PropertyI64 triggerMode

Defines if the selected trigger is active.

◆ triggerOverlap

Specifies the type trigger overlap permitted with the previous frame.

This defines when a valid trigger will be accepted (or latched) for a new frame. Valid values for this property are defined by the enumeration mvIMPACT::acquire::TDeviceTriggerOverlap.

◆ triggerSource

PropertyI64 triggerSource

Defines the signal that will cause the trigger event.

Currently this property will define a translation dictionary that can e.g. be queried via a call to mvIMPACT::acquire::PropertyI64::getTranslationDict. The resulting translation dictionary can be used to select the desired trigger source either via a string or the associated 64 bit integer value.


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