mvIMPACT Acquire SDK C++
OutputSignalGeneratorBlueDevice Class Reference

A class to create complex digital output signals(Device specific interface layout only). More...

Public Member Functions

bool canCreateExposeActiveSignal (DigitalOutput *pOutput) const
 Checks whether the specified output can be used to create an inverted expose active signal. More...
 
bool canInvertSignal (DigitalOutput *pOutput) const
 Checks whether the specified output can be used to create an inverted version of a certain signal. More...
 
TDeviceDigitalOutputMode getOutputMode (DigitalOutput *pOutput) const
 Returns the current mode a digital output is operated in. More...
 
bool isOutputModeActive (DigitalOutput *pOutput, TDeviceDigitalOutputMode mode) const
 Checks whether the specified output is currently operated in a certain mode. More...
 
bool isSignalInverted (DigitalOutput *pOutput) const
 Checks whether the specified output will currently invert a certain internal signal. More...
 
OutputSignalGeneratorBlueDeviceoperator= (const OutputSignalGeneratorBlueDevice &rhs)
 Allows assignments of mvIMPACT::acquire::OutputSignalGeneratorBlueDevice objects. More...
 
 OutputSignalGeneratorBlueDevice (const OutputSignalGeneratorBlueDevice &src)
 Constructs a new mvIMPACT::acquire::OutputSignalGeneratorBlueDevice from and existing one. More...
 
 OutputSignalGeneratorBlueDevice (Device *pDev)
 Constructs a new mvIMPACT::acquire::OutputSignalGeneratorBlueDevice object. More...
 
int setOutputMode (DigitalOutput *pOutput, TDeviceDigitalOutputMode mode, bool boInverted=false)
 This function will configure the digital output to operate in a certain mode. More...
 
int undefineSignal (DigitalOutput *pOutput)
 Removes the signal definition from the specified output pin. More...
 
 ~OutputSignalGeneratorBlueDevice ()
 Class destructor. More...
 

Detailed Description

A class to create complex digital output signals(Device specific interface layout only).

Instances of this class can be used to create more complex digital output related signals like a single pulse or sequence of pulses on a certain pin as a reaction on a signal on one of the digital inputs of a device.

The availability of the features provided by this class heavily depends on the used capture device. Therefore it's crucial to check if a desired feature is available at all. This class either provides the functions needed for these checks or its functions will return appropriate error codes.

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

◆ OutputSignalGeneratorBlueDevice() [1/2]

OutputSignalGeneratorBlueDevice ( Device pDev)
inlineexplicit

Constructs a new mvIMPACT::acquire::OutputSignalGeneratorBlueDevice object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.

◆ OutputSignalGeneratorBlueDevice() [2/2]

Constructs a new mvIMPACT::acquire::OutputSignalGeneratorBlueDevice from and existing one.

Parameters
[in]srcA constant reference to the mvIMPACT::acquire::OutputSignalGeneratorBlueDevice object, this object shall be created from

◆ ~OutputSignalGeneratorBlueDevice()

Class destructor.

Member Function Documentation

◆ canCreateExposeActiveSignal()

bool canCreateExposeActiveSignal ( DigitalOutput pOutput) const
inline

Checks whether the specified output can be used to create an inverted expose active signal.

Parameters
[in]pOutputA pointer to a mvIMPACT::acquire::DigitalOutput object obtained from an instance of the class mvIMPACT::acquire::IOSubSystemCommon for this device.

◆ canInvertSignal()

bool canInvertSignal ( DigitalOutput pOutput) const
inline

Checks whether the specified output can be used to create an inverted version of a certain signal.

Parameters
[in]pOutputA pointer to a mvIMPACT::acquire::DigitalOutput object obtained from an instance of the class mvIMPACT::acquire::IOSubSystemCommon for this device.

◆ getOutputMode()

TDeviceDigitalOutputMode getOutputMode ( DigitalOutput pOutput) const
inline

Returns the current mode a digital output is operated in.

If the mode is not selectable for the current output an exception will be raised.

Parameters
[in]pOutputA pointer to a mvIMPACT::acquire::DigitalOutput object obtained from an instance of the class mvIMPACT::acquire::IOSubSystemCommon for this device.

◆ isOutputModeActive()

bool isOutputModeActive ( DigitalOutput pOutput,
TDeviceDigitalOutputMode  mode 
) const
inline

Checks whether the specified output is currently operated in a certain mode.

Parameters
[in]pOutputA pointer to a mvIMPACT::acquire::DigitalOutput object obtained from an instance of the class mvIMPACT::acquire::IOSubSystemCommon for this device.
[in]modeThe mode the specified output shall be checked for.

◆ isSignalInverted()

bool isSignalInverted ( DigitalOutput pOutput) const
inline

Checks whether the specified output will currently invert a certain internal signal.

Parameters
[in]pOutputA pointer to a mvIMPACT::acquire::DigitalOutput object obtained from an instance of the class mvIMPACT::acquire::IOSubSystemCommon for this device.

◆ operator=()

◆ setOutputMode()

int setOutputMode ( DigitalOutput pOutput,
TDeviceDigitalOutputMode  mode,
bool  boInverted = false 
)
inline

This function will configure the digital output to operate in a certain mode.

After calling this function the digital output will be operated in the mode specified by mode.

Valid values for constant are defined by the enum mvIMPACT::acquire::TDeviceDigitalOutputMode.

Returns
Parameters
[in]pOutputA pointer to a mvIMPACT::acquire::DigitalOutput object obtained from an instance of the class mvIMPACT::acquire::IOSubSystemCommon for this device.
[in]modeThe mode the specified output shall be operated in. If the mode passed to the function is not available for the output or the device an exception will be raised.
[in]boInvertedSet this parameter to true, to invert the exposure signal

◆ undefineSignal()

int undefineSignal ( DigitalOutput pOutput)
inline

Removes the signal definition from the specified output pin.

Whenever a signal has been defined for a a certain digital output pin, this pin can no longer controlled using the corresponding functions in the class mvIMPACT::acquire::DigitalOutput. This function removes the signal definition and hands back manual control of that digital output to the user.

Returns
Parameters
[in]pOutputA pointer to a mvIMPACT::acquire::DigitalOutput object obtained from an instance of the class mvIMPACT::acquire::IOSubSystemCommon for this device.

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