Impact Acquire SDK .NET
IOSubSystemCommon Class Reference
Device Specific Interface Layout

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

Inheritance diagram for IOSubSystemCommon:
[legend]

Public Member Functions

PulseStartConfiguration getPulseStartConfiguration (int nr)
 Returns a pointer to a mv.impact.acquire.PulseStartConfiguration associated with this device.
RTCtrProgram getRTCtrProgram (int nr)
 Returns a pointer to a mv.impact.acquire.RTCtrProgram associated with this device.
DigitalInput input (int nr)
 Returns a const pointer to a mv.impact.acquire.DigitalInput object.
 IOSubSystemCommon (Device device)
DigitalOutput output (int nr)
 Returns a pointer to a mv.impact.acquire.DigitalOutput object.
override uint readInputRegister ()
 Returns the current state of the digital input register.
override uint readOutputRegister ()
 Returns the current state of the digital output register.
override void writeOutputRegister (uint value)
 Alters the state of the digital output register.
override void writeOutputRegister (uint value, uint mask)
 Alters the state of the digital output register.

Properties

int inputCount [get]
 Returns the number of mv.impact.acquire.DigitalInput s available for the mv.impact.acquire.Device associated with this object.
int outputCount [get]
 Returns the number of digital outputs available for the mv.impact.acquire.Device associated with this object.
int pulseStartConfigurationCount [get]
 Returns the number of mv.impact.acquire.PulseStartConfiguration objects available for the mv.impact.acquire.Device associated with this object.
int RTCtrProgramCount [get]
 Returns the number of mv.impact.acquire.RTCtrProgram s available for the mv.impact.acquire.Device associated with this object.

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 mv.impact.acquire.IOSubSystem.

ExampleS(lists all available digital inputs and outputs and their description):

using mv.impact.acquire;
void listIOPins( IOSubSystemCommon io )
{
int iCnt = io.inputCount;
Console.WriteLine( "Available digital inputs: {0}", iCnt);
for( int d=0; d<iCnt; d++ )
{
Console.WriteLine( io.input(d).description );
}
int oCnt = io.outputCount;
Console.WriteLine( "Available digital outputs: {0}", oCnt);
// set all available digital outputs to high
for( int e=0; e<oCnt; e++ )
{
DigitalOutput pOutput = io.output(e);
Console.WriteLine( "Setting {0} to high", pOutput.description);
pOutput.set();
}
}
mv.impact.acquire.DigitalIO.description
String description
Returns a description for this digital output.
Definition DigitalIO.cs:74
mv.impact.acquire.DigitalOutput
A class to represent a digital output pin(Device specific interface layout only).
Definition DigitalIO.cs:91
mv.impact.acquire.DigitalOutput.set
void set()
Sets the output pin to 'logic 1'.
Definition DigitalIO.cs:122
mv.impact.acquire.IOSubSystemCommon.IOSubSystemCommon
IOSubSystemCommon(Device device)
Definition IOSubSystemCommon.cs:58
mv.impact.acquire.IOSubSystem.input
DigitalInput input(int nr)
Returns a const pointer to a mv.impact.acquire.DigitalInput object.
Definition IOSubSystem.cs:131
mv.impact.acquire.IOSubSystem.output
DigitalOutput output(int nr)
Returns a pointer to a mv.impact.acquire.DigitalOutput object.
Definition IOSubSystem.cs:144
mv.impact.acquire.IOSubSystem.inputCount
int inputCount
Returns the number of mv.impact.acquire.DigitalInput s available for the mv.impact....
Definition IOSubSystem.cs:233
mv.impact.acquire.IOSubSystem.outputCount
int outputCount
Returns the number of digital outputs available for the mv.impact.acquire.Device associated with this...
Definition IOSubSystem.cs:235
mv.impact.acquire
This namespace contains classes and functions belonging to the image acquisition module of this SDK.
Definition Enumerations.cs:2
Note
This class will only be available if mv.impact.acquire.Device.interfaceLayout is set to mv.impact.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ IOSubSystemCommon()

IOSubSystemCommon ( Device device)
inline

Member Function Documentation

◆ getPulseStartConfiguration()

PulseStartConfiguration getPulseStartConfiguration ( int nr)
inlineinherited

Returns a pointer to a mv.impact.acquire.PulseStartConfiguration associated with this device.

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

◆ getRTCtrProgram()

RTCtrProgram getRTCtrProgram ( int nr)
inlineinherited

Returns a pointer to a mv.impact.acquire.RTCtrProgram associated with this device.

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

◆ input()

DigitalInput input ( int nr)
inlineinherited

Returns a const pointer to a mv.impact.acquire.DigitalInput object.

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 mv.impact.acquire.IOSubSystem.readInputRegister.
Parameters
[in]nrThe number of the digital input.
Examples
DigitalIOs.cs.

◆ output()

DigitalOutput output ( int nr)
inlineinherited

Returns a pointer to a mv.impact.acquire.DigitalOutput object.

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 mv.impact.acquire.IOSubSystem.writeOutputRegister with the corresponding bit mask.
Parameters
[in]nrThe number of the digital output.
Examples
DigitalIOs.cs.

◆ readInputRegister()

override uint readInputRegister ( )
inlinesealed

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

◆ readOutputRegister()

override uint readOutputRegister ( )
inlinesealed

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

◆ writeOutputRegister() [1/2]

override void writeOutputRegister ( uint value)
inlinesealedvirtual

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 mv.impact.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

Reimplemented from IOSubSystem.

◆ writeOutputRegister() [2/2]

override void writeOutputRegister ( uint value,
uint mask )
inlinesealed

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 mv.impact.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.

Property Documentation

◆ inputCount

int inputCount
getinherited

Returns the number of mv.impact.acquire.DigitalInput s available for the mv.impact.acquire.Device associated with this object.

Examples
DigitalIOs.cs.

◆ outputCount

int outputCount
getinherited

Returns the number of digital outputs available for the mv.impact.acquire.Device associated with this object.

Examples
DigitalIOs.cs.

◆ pulseStartConfigurationCount

int pulseStartConfigurationCount
getinherited

Returns the number of mv.impact.acquire.PulseStartConfiguration objects available for the mv.impact.acquire.Device associated with this object.

Examples
DigitalIOs.cs.

◆ RTCtrProgramCount

int RTCtrProgramCount
getinherited

Returns the number of mv.impact.acquire.RTCtrProgram s available for the mv.impact.acquire.Device associated with this object.

Examples
DigitalIOs.cs.