Impact Acquire SDK Java
DigitalOutput Class Reference

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

Public Member Functions

synchronized void delete ()
 
boolean flip ()
 Inverts the current state of the digital output and returns the previous state.
 
boolean get ()
 Returns the current state of this output pin.
 
String getDescription ()
 Returns a description for this digital output.
 
boolean isWriteable ()
 Checks if the caller has write/modify access to this digital output.
 
void reset ()
 Sets the output pin to 'logic 0'.
 
void set ()
 Sets the output pin to 'logic 1'.
 

Protected Member Functions

 DigitalOutput (long cPtr, boolean cMemoryOwn)
 
void finalize ()
 

Static Protected Member Functions

static long swigRelease (DigitalOutput obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

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.getInterfaceLayout() is set to mvIMPACT.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ DigitalOutput()

DigitalOutput ( long cPtr,
boolean cMemoryOwn )
protected

Member Function Documentation

◆ delete()

synchronized void delete ( )

◆ finalize()

void finalize ( )
protected

◆ flip()

boolean flip ( )

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()

boolean get ( )

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()

String getDescription ( )

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.

◆ isWriteable()

boolean isWriteable ( )

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()

void reset ( )

Sets the output pin to 'logic 0'.

◆ set()

void set ( )

Sets the output pin to 'logic 1'.

◆ swigRelease()

static long swigRelease ( DigitalOutput obj)
staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protected