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

Inheritance diagram for IOSubSystemCommon:

Public Member Functions
	__init__ (self, pDev)
	Constructs a new mvIMPACT.acquire.IOSubSystemCommon object.
	getInput (self, nr)
	Returns a const pointer to a mvIMPACT.acquire.DigitalInput object.
	getInputCount (self)
	Returns the number of mvIMPACT.acquire.DigitalInput s available for the mvIMPACT.acquire.Device associated with this object.
	getOutput (self, nr)
	Returns a pointer to a mvIMPACT.acquire.DigitalOutput object.
	getOutputCount (self)
	Returns the number of digital outputs available for the mvIMPACT.acquire.Device associated with this object.
	getPulseStartConfiguration (self, nr)
	Returns a pointer to a mvIMPACT.acquire.PulseStartConfiguration associated with this device.
	getPulseStartConfigurationCount (self)
	Returns the number of mvIMPACT.acquire.PulseStartConfiguration objects available for the mvIMPACT.acquire.Device associated with this object.
	getRTCtrProgram (self, nr)
	Returns a pointer to a mvIMPACT.acquire.RTCtrProgram associated with this device.
	getRTCtrProgramCount (self)
	Returns the number of mvIMPACT.acquire.RTCtrProgram s available for the mvIMPACT.acquire.Device associated with this object.
	readInputRegister (self)
	Returns the current state of the digital input register.
	readOutputRegister (self)
	Returns the current state of the digital output register.
	writeOutputRegister (self, *args)
	Alters the state of the digital output register.

Properties
	inputCount = property (getInputCount, None, None, None)
	An integer property (read-only) which holds the number of mvIMPACT.acquire.DigitalInput s available for the mvIMPACT.acquire.Device associated with this object.
	outputCount = property (getOutputCount, None, None, None)
	An integer property (read-only) which holds the number of digital outputs available for the mvIMPACT.acquire.Device associated with this object.
	pulseStartConfigurationCount = property (getPulseStartConfigurationCount, None, None, None)
	An integer property (read-only) which holds the number of mvIMPACT.acquire.PulseStartConfiguration objects available for the mvIMPACT.acquire.Device associated with this object.
	RTCtrProgramCount = property (getRTCtrProgramCount, None, None, None)
	An integer property (read-only) which holds the number of mvIMPACT.acquire.RTCtrProgram s available for the mvIMPACT.acquire.Device associated with this object.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

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.

def listIOPins(pDev):
  io = acquire.IOSubSystemCommon(pDev)
  iCnt = io.getInputCount()
  print("available digital inputs: " + str(iCnt))
  for d in range(iCnt):
      print(io.getInput(d).getDescription())
 
  oCnt = io.getOutputCount()
  print("available digital outputs: " + str(oCnt))
  for e in range(oCnt):
      pOutput = io.getOutput(e)
      print("setting " + pOutput.getDescription() + " to high")
      # set this output to logic '1'
      pOutput.state = True

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

◆ init()

__init__	(		self,
			pDev )

Constructs a new mvIMPACT.acquire.IOSubSystemCommon object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.

Member Function Documentation

◆ getInput()

getInput	(		self,
			nr )

inherited

Returns a const pointer to a mvIMPACT.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 mvIMPACT.acquire.IOSubSystem.readInputRegister.

Parameters

nr	[in] The number of the digital input.

◆ getInputCount()

getInputCount ( self )

inherited

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

◆ getOutput()

getOutput	(		self,
			nr )

inherited

Returns a pointer to a mvIMPACT.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 mvIMPACT.acquire.IOSubSystem.writeOutputRegister with the corresponding bit mask.

Parameters

nr	[in] The number of the digital output.

◆ getOutputCount()

getOutputCount ( self )

inherited

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

◆ getPulseStartConfiguration()

getPulseStartConfiguration	(		self,
			nr )

inherited

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

Parameters

nr	[in] The number of the pulse start configuration to return

◆ getPulseStartConfigurationCount()

getPulseStartConfigurationCount ( self )

inherited

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

◆ getRTCtrProgram()

getRTCtrProgram	(		self,
			nr )

inherited

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

Parameters

nr	[in] The number of the real time controller program to return

◆ getRTCtrProgramCount()

getRTCtrProgramCount ( self )

inherited

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

◆ readInputRegister()

readInputRegister ( self )

inherited

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.

◆ readOutputRegister()

readOutputRegister ( self )

inherited

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.

◆ writeOutputRegister()

writeOutputRegister	(		self,
		*	args )

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

value	[in] The value to be applied to the output register
mask	[in] The 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.

Reimplemented from IOSubSystem.

Property Documentation

◆ inputCount

inputCount = property (getInputCount, None, None, None)

staticinherited

An integer property (read-only) which holds the number of mvIMPACT.acquire.DigitalInput s available for the mvIMPACT.acquire.Device associated with this object.

See mvIMPACT.acquire.IOSubSystem.getInputCount()

◆ outputCount

outputCount = property (getOutputCount, None, None, None)

staticinherited

An integer property (read-only) which holds the number of digital outputs available for the mvIMPACT.acquire.Device associated with this object.

See mvIMPACT.acquire.IOSubSystem.getOutputCount()

◆ pulseStartConfigurationCount

pulseStartConfigurationCount = property (getPulseStartConfigurationCount, None, None, None)

staticinherited

An integer property (read-only) which holds the number of mvIMPACT.acquire.PulseStartConfiguration objects available for the mvIMPACT.acquire.Device associated with this object.

See mvIMPACT.acquire.IOSubSystem.getPulseStartConfigurationCount()

◆ RTCtrProgramCount

RTCtrProgramCount = property (getRTCtrProgramCount, None, None, None)

staticinherited

An integer property (read-only) which holds the number of mvIMPACT.acquire.RTCtrProgram s available for the mvIMPACT.acquire.Device associated with this object.

See mvIMPACT.acquire.IOSubSystem.getRTCtrProgramCount()

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ getInput()

◆ getInputCount()

◆ getOutput()

◆ getOutputCount()

◆ getPulseStartConfiguration()

◆ getPulseStartConfigurationCount()

◆ getRTCtrProgram()

◆ getRTCtrProgramCount()

◆ readInputRegister()

◆ readOutputRegister()

◆ writeOutputRegister()

Property Documentation

◆ inputCount

◆ outputCount

◆ pulseStartConfigurationCount

◆ RTCtrProgramCount

◆ thisown

◆ init()