mvIMPACT Acquire SDK C++
PulseStartConfiguration Class Reference

A class to configure the creation of digital signals passed to one or more of the digital outputs of a device(Device specific interface layout only). More...

Inheritance diagram for PulseStartConfiguration:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
int number (void) const
 Returns the internal number associated with this pulse start configuration. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyIDigitalSignal digitalSignal
 An enumerated property to define one or more signals that will trigger the creation of the associated output signals. More...
 
PropertyI divider
 An integer property defining a factor by which the external input signal shall divided. More...
 
PropertyF frequency_Hz
 A float property defining the frequency in Hz. for the creation of the output signals associated with configuration. More...
 
PropertyIPulseStartTrigger pulseStartTrigger
 An enumerated integer property that will define how/when a digital signal is generated by the device. More...
 
PropertyITriggerMoment triggerMoment
 An enumerated integer property defining the exact moment when this pulse start configuration shall be triggered. More...
 

Protected Attributes

HOBJ m_hRoot
 

Friends

class IOSubSystem
 

Detailed Description

A class to configure the creation of digital signals passed to one or more of the digital outputs of a device(Device specific interface layout only).

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.

◆ number()

int number ( void  ) const
inline

Returns the internal number associated with this pulse start configuration.

◆ 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

◆ IOSubSystem

friend class IOSubSystem
friend

Member Data Documentation

◆ digitalSignal

PropertyIDigitalSignal digitalSignal

An enumerated property to define one or more signals that will trigger the creation of the associated output signals.

This property will be visible and thus active when mvIMPACT::acquire::PulseStartConfiguration::digitalSignal is switched to mvIMPACT::acquire::pstDigitalSignal.

Depending on the device one or more signals can be defined as 'active for output signal creation'. When more than one signal can be defined, calling mvIMPACT::acquire::PropertyIDigitalSignal::allowsValueCombinations will return true.

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

mvHYPERION specific: Currently when more than one signal can be defined here, these signals will have an 'or relationship', which means that when any of these signals is detected, it will trigger the creation of the associated output signals.

The following signals are defined:

enum Value Associated signal
mvIMPACT::acquire::dsSignal1 Line Valid(J1)
mvIMPACT::acquire::dsSignal2 Line Valid(J2)
mvIMPACT::acquire::dsSignal3 Frame Valid(J1)
mvIMPACT::acquire::dsSignal4 Frame Valid(J2)
mvIMPACT::acquire::dsSignal5 Trigger-In(J3.4/J3.5)
mvIMPACT::acquire::dsSignal6 Sync-In(J3.6/J3.7)
mvIMPACT::acquire::dsSignal7 Trigger-In(J4.4/J4.5)
mvIMPACT::acquire::dsSignal8 Sync-In(J4.6/J4.7)
mvIMPACT::acquire::dsSignal9 DigIn0(J6.9)
mvIMPACT::acquire::dsSignal10 DigIn1(J6.10)
mvIMPACT::acquire::dsSignal11 DigIn2(J6.11)
mvIMPACT::acquire::dsSignal12 DigIn3(J6.12)

◆ divider

PropertyI divider

An integer property defining a factor by which the external input signal shall divided.

Every divider-value pulse will be used then. All others will be skipped.

◆ frequency_Hz

PropertyF frequency_Hz

A float property defining the frequency in Hz. for the creation of the output signals associated with configuration.

This property will be visible and thus active when mvIMPACT::acquire::PulseStartConfiguration::digitalSignal is switched to mvIMPACT::acquire::pstPeriodically.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ pulseStartTrigger

PropertyIPulseStartTrigger pulseStartTrigger

An enumerated integer property that will define how/when a digital signal is generated by the device.

When certain digital output signals

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

Note
Not every device will offer the same options. Check for valid modes by reading 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.

◆ triggerMoment

PropertyITriggerMoment triggerMoment

An enumerated integer property defining the exact moment when this pulse start configuration shall be triggered.

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


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