mvIMPACT Acquire SDK C++
IOSubSystemCommon Class Reference

A base class to handle the digital inputs and outputs for devices (Device specific interface layout only). More...

Inheritance diagram for IOSubSystemCommon:
IOSubSystem IOSubSystemFrameGrabber

Public Member Functions

unsigned int getInputCount (void) const
 Returns the number of mvIMPACT::acquire::DigitalInput s available for the mvIMPACT::acquire::Device associated with this object. More...
 
unsigned int getOutputCount (void) const
 Returns the number of digital outputs available for the mvIMPACT::acquire::Device associated with this object. More...
 
PulseStartConfigurationgetPulseStartConfiguration (unsigned int nr) const
 Returns a pointer to a mvIMPACT::acquire::PulseStartConfiguration associated with this device. More...
 
unsigned int getPulseStartConfigurationCount (void) const
 Returns the number of mvIMPACT::acquire::PulseStartConfiguration objects available for the mvIMPACT::acquire::Device associated with this object. More...
 
RTCtrProgramgetRTCtrProgram (unsigned int nr) const
 Returns a pointer to a mvIMPACT::acquire::RTCtrProgram associated with this device. More...
 
const DigitalInputinput (unsigned int nr) const
 Returns a const pointer to a mvIMPACT::acquire::DigitalInput object. More...
 
 IOSubSystemCommon (Device *pDev)
 Constructs a new mvIMPACT::acquire::IOSubSystemCommon object. More...
 
DigitalOutputoutput (unsigned int nr) const
 Returns a pointer to a mvIMPACT::acquire::DigitalOutput object. More...
 
virtual unsigned int readInputRegister (void) const
 Returns the current state of the digital input register. More...
 
virtual unsigned int readOutputRegister (void) const
 Returns the current state of the digital output register. More...
 
unsigned int RTCtrProgramCount (void) const
 Returns the number of mvIMPACT::acquire::RTCtrProgram s available for the mvIMPACT::acquire::Device associated with this object. More...
 
void writeOutputRegister (unsigned int value, unsigned int mask=UINT_MAX)
 Alters the state of the digital output register. More...
 

Detailed Description

A base class to handle the digital inputs and outputs for devices (Device specific interface layout only).

This class provides a convenient basic access to the digital inputs and outputs of almost every device supported by this interface.

Note
This class may NOT be used for mvBlueFOX devices.
The number of digital inputs and outputs available will vary significantly from device to device. Some devices might not even have digital inputs and/or digital outputs. Therefore it's crucial to check for available pins before using them. The corresponding functions to do that can be found in the base class mvIMPACT::acquire::IOSubSystem.
#include <iostream>
using namespace std;
using namespace mvIMPACT::acquire;
// lists all available digital inputs and outputs and their description
void listIOPins( Device* pDev )
{
IOSubSystemCommon io( pDev );
unsigned int iCnt = io.getInputCount();
cout << "available digital inputs: " << iCnt << endl;
for( unsigned int d=0; d<iCnt; d++ )
{
out << io.input(d)->getDescription() << endl;
}
unsigned int oCnt = io.getOutputCount();
cout << "available digital outputs: " << oCnt << endl;
for( unsigned int e=0; e<oCnt; e++ )
{
DigitalOutput* pOutput = io.output(e);
out << "setting " << pOutput->getDescription() << " to high" << endl;
// set this output to logic '1'
pOutput->set();
}
}
IOSubSystemCommon(Device *pDev)
Constructs a new mvIMPACT::acquire::IOSubSystemCommon object.
Definition: mvIMPACT_acquire.h:17153
This namespace contains classes and functions belonging to the image acquisition module of this SDK.
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

◆ IOSubSystemCommon()

IOSubSystemCommon ( Device pDev)
inlineexplicit

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

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

Member Function Documentation

◆ getInputCount()

unsigned int getInputCount ( void  ) const
inlineinherited

Returns the number of mvIMPACT::acquire::DigitalInput s available for the mvIMPACT::acquire::Device associated with this object.

◆ getOutputCount()

unsigned int getOutputCount ( void  ) const
inlineinherited

Returns the number of digital outputs available for the mvIMPACT::acquire::Device associated with this object.

◆ getPulseStartConfiguration()

PulseStartConfiguration* getPulseStartConfiguration ( unsigned int  nr) const
inlineinherited

Returns a pointer to a mvIMPACT::acquire::PulseStartConfiguration associated with this device.

If nr is invalid(too large) a STL out_of_range exception will be thrown.

Parameters
[in]nrThe number of the pulse start configuration to return

◆ getPulseStartConfigurationCount()

unsigned int getPulseStartConfigurationCount ( void  ) const
inlineinherited

Returns the number of mvIMPACT::acquire::PulseStartConfiguration objects available for the mvIMPACT::acquire::Device associated with this object.

◆ getRTCtrProgram()

RTCtrProgram* getRTCtrProgram ( unsigned int  nr) const
inlineinherited

Returns a pointer to a mvIMPACT::acquire::RTCtrProgram associated with this device.

If nr is invalid(too large) a STL out_of_range exception will be thrown.

Parameters
[in]nrThe number of the real time controller program to return

◆ input()

const DigitalInput* input ( unsigned int  nr) const
inlineinherited

Returns a const pointer to a mvIMPACT::acquire::DigitalInput object.

If nr references an invalid pin a STL out_of_range exception will be thrown.

Note
The possibility to access the digital inputs of a device as single objects is just provided for convenience. The same thing can be achieved by calling the function mvIMPACT::acquire::IOSubSystem::readInputRegister.
Parameters
[in]nrThe number of the digital input.

◆ output()

DigitalOutput* output ( unsigned int  nr) const
inlineinherited

Returns a pointer to a mvIMPACT::acquire::DigitalOutput object.

If nr references an invalid pin a STL out_of_range exception will be thrown.

Note
The possibility to access the digital outputs of a device as single objects is just provided for convenience. The same thing can be achieved by calling the function mvIMPACT::acquire::IOSubSystem::writeOutputRegister with the corresponding bit mask.
Parameters
[in]nrThe number of the digital output.

◆ readInputRegister()

virtual unsigned int readInputRegister ( void  ) const
inlinevirtual

Returns the current state of the digital input register.

This function can be used to read all digital inputs as a single value. Each bit represents the status of one digital output pin.

EXAMPLE

A value of '3' returned by this function means that digital inputs 0 and 1 are currently have a voltage considered as logical '1' applied to them.

Returns
The current state of the digital inputs where bit 0 in the result represents the state of digital input 0, bit 1 the state of digital input 1 a.s.o.

Implements IOSubSystem.

◆ readOutputRegister()

virtual unsigned int readOutputRegister ( void  ) const
inlinevirtual

Returns the current state of the digital output register.

This function can be used to read all digital outputs as a single value. Each bit represents the status of one digital output pin.

EXAMPLE

A value of '3' returned by this function means that digital output 0 and 1 are currently set to high.

Returns
The current state of the digital outputs where bit 0 in the result represents the state of digital output 0, bit 1 the state of digital output 1 a.s.o.

Implements IOSubSystem.

◆ RTCtrProgramCount()

unsigned int RTCtrProgramCount ( void  ) const
inlineinherited

Returns the number of mvIMPACT::acquire::RTCtrProgram s available for the mvIMPACT::acquire::Device associated with this object.

◆ writeOutputRegister()

void writeOutputRegister ( unsigned int  value,
unsigned int  mask = UINT_MAX 
)
inlinevirtual

Alters the state of the digital output register.

This function can be used to alter the state of certain (or all) digital outputs with a single function call. By working with the parameter mask certain bits can remain unaffected.

EXAMPLE

If the previous state of a digital output register was '5', which means that outputs 0 and 2 are set to high a call to mvIMPACT::acquire::IOSubSystem::writeOutputRegister with value set to 2 and mask set to 3 would result in '6' as the new value for the output register. Pin 2 will remain unaffected, as mask states just to modify pin 0 and 1 ( 3 = 00000011 binary ).

Parameters
[in]valueThe value to be applied to the output register
[in]maskThe mask to specify which pins to modify. A bit set to '1' in this parameter means that the state of this output has to adopt its style according to the value in value.

Implements IOSubSystem.


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