Impact Acquire SDK C++
DigitalInput Class Reference

A class to represent a digital input pin(Device specific interface layout only). More...

#include <mvIMPACT_acquire.h>

Public Member Functions

bool get (void) const
 Returns the current state of this input pin.
 
std::string getDescription (void) const
 Returns a description for this digital input.
 

Friends

class IOSubSystem
 

Detailed Description

A class to represent a digital input pin(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

◆ get()

bool get ( void ) const
inline

Returns the current state of this input pin.

Returns
  • true if the current state of this pin is considered as 'logic 1'
  • false otherwise
Examples
DigitalIOs.cpp, and DigitalIOs.legacy.cpp.

◆ getDescription()

std::string getDescription ( void ) const
inline

Returns a description for this digital input.

This might contain connector descriptions or other information like e.g. 'Trigger-In(J8.4/J8.5)', which means, this is the trigger input of connector J8 pins 4 and 5.

Examples
DigitalIOs.cpp, and DigitalIOs.legacy.cpp.

Friends And Related Symbol Documentation

◆ IOSubSystem

friend class IOSubSystem
friend