DigitalOutput Class Reference

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

Inheritance diagram for DigitalOutput:

Public Member Functions
	__init__ (self, *args, **kwargs)
	flip (self)
	Inverts the current state of the digital output and returns the previous state.
	get (self)
	Returns the current state of this output pin.
	getDescription (self)
	Returns a description for this digital output.
	getIsWriteable (self)
	Checks if the caller has write/modify access to this digital output.
	reset (self)
	Sets the output pin to 'logic 0'.
	set (self)
	Sets the output pin to 'logic 1'.
	setState (self, boState)

Properties
	description = property (getDescription, None, None, None)
	A string property (read-only) which holds a description for this digital output.
	isWriteable = property (getIsWriteable, None, None, None)
	A bool property (read-only) which checks if the caller has write/modify access to this digital output.
	state = property (get, setState, None, None)
	A bool property which defines the output state of this digital output.
	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 output 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

flip()

flip

(

self

)

Inverts the current state of the digital output and returns the previous state.

Returns

• true if the previous state of this pin was considered as 'logic 1'
• false otherwise

get()

get

(

self

)

Returns the current state of this output 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 output.

This might contain connector descriptions or other information like e.g. 'CC1(J1)', which means, this is the CameraLink® control channel 1 of connector J1.

getIsWriteable()

getIsWriteable

(

self

)

Checks if the caller has write/modify access to this digital output.

Some devices will offer access to digital outputs, but these outputs can't be switched manually. E.g. a device might offer a digital output that can only be configured to stay either high or low during frame exposure but can't be switched to high at a certain user defined moment. For such an output, this function will return false.

If the user calls a function belonging to this class that would modify the state of the associated digital output, an exception will be raised.

Returns

• true if the caller is allowed to call write/modify operation for this component.
• false otherwise.

reset()

reset

(

self

)

Sets the output pin to 'logic 0'.

set()

set

(

self

)

Sets the output pin to 'logic 1'.

setState()

setState	(		self,
			boState )

Property Documentation

description

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

static

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

See mvIMPACT.acquire.DigitalOutput.getDescription()

isWriteable

isWriteable = property (getIsWriteable, None, None, None)

static

A bool property (read-only) which checks if the caller has write/modify access to this digital output.

See mvIMPACT.acquire.DigitalOutput.getIsWriteable()

state

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

static

A bool property which defines the output state of this digital output.

See mvIMPACT.acquire.DigitalOutput.get(), mvIMPACT.acquire.DigitalOutput.set() and mvIMPACT.acquire.DigitalOutput.reset()

thisown

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

static