Impact Acquire SDK .NET
DigitalOutput Class Referencesealed

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

Inheritance diagram for DigitalOutput:
[legend]

Public Member Functions

bool flip ()
 Inverts the current state of the digital output and returns the previous state.
 
override bool get ()
 Returns the current state of this output pin.
 
void reset ()
 Sets the output pin to 'logic 0'.
 
void set ()
 Sets the output pin to 'logic 1'.
 
override String ToString ()
 Returns a description for this digital pin.
 

Properties

String description [get]
 Returns a description for this digital output.
 
bool isWriteable [get]
 Checks if the caller has write/modify access to this digital output.
 

Detailed Description

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

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.
Examples
DigitalIOs.cs.

Member Function Documentation

◆ flip()

bool flip ( )
inline

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
Examples
DigitalIOs.cs.

◆ get()

override bool get ( )
inline

Returns the current state of this output pin.

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

◆ reset()

void reset ( )
inline

Sets the output pin to 'logic 0'.

Examples
DigitalIOs.cs.

◆ set()

void set ( )
inline

Sets the output pin to 'logic 1'.

Examples
DigitalIOs.cs.

◆ ToString()

override String ToString ( )
inlineinherited

Returns a description for this digital pin.

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.

Property Documentation

◆ description

String description
getinherited

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.

Examples
DigitalIOs.cs.

◆ isWriteable

bool isWriteable
get

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.
Examples
DigitalIOs.cs.