Impact Acquire SDK Python
DigitalInput Class Reference

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

Inheritance diagram for DigitalInput:
[legend]

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 get (self)
 Returns the current state of this input pin.
 
 getDescription (self)
 Returns a description for this digital input.
 

Properties

 description = property (getDescription, None, None, None)
 A string property (read-only) which holds a description for this digital input.
 
 state = property (get, None, None, None)
 A bool property (read-only) which defines the output state of this digital input.
 
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

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.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args,
** kwargs )

Member Function Documentation

◆ get()

get ( self)

Returns the current state of this input pin.

Returns
  • true if the current state of this pin is considered as 'logic 1'
  • false otherwise

◆ getDescription()

getDescription ( self)

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.

Property Documentation

◆ description

description = property (getDescription, None, None, None)
static

A string property (read-only) which holds a description for this digital input.

See mvIMPACT.acquire.DigitalInput.getDescription()

◆ state

state = property (get, None, None, None)
static

A bool property (read-only) which defines the output state of this digital input.

See mvIMPACT.acquire.DigitalInput.get()

◆ thisown

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