com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel Class Reference

Inheritance diagram for com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel:

Collaboration diagram for com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel:

Public Member Functions
	DigitalInputChannel (DyIOChannel channel, boolean async)
	DigitalInputChannel (int channel)
	DigitalInputChannel (DyIO dyio, int channel)
	DigitalInputChannel (DyIOChannel channel)
boolean	isHigh ()
void	setAsync (boolean isAsync)
void	removeAllDigitalInputListeners ()
void	removeDigitalInputListener (IDigitalInputListener l)
void	addDigitalInputListener (IDigitalInputListener l)
void	onChannelEvent (DyIOChannelEvent e)
boolean	hasAsync ()
Public Member Functions inherited from com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral
	DyIOAbstractPeripheral (DyIOChannel channel, DyIOChannelMode myMode, boolean async)
DyIOChannelMode	getClassMode ()
boolean	isEnabled ()
boolean	setMode ()
boolean	setMode (boolean async)
boolean	setMode (DyIOChannelMode mode, boolean async)
DyIOChannel	getChannel ()
DyIOChannelMode	getMode ()
boolean	setValue (int value) throws InvalidResponseException
boolean	setValue (ByteList value) throws InvalidResponseException
int	getValue () throws InvalidResponseException
boolean	SavePosition (int pos)
boolean	configAdvancedAsyncNotEqual ()
boolean	configAdvancedAsyncDeadBand (int deadbandSize)
boolean	configAdvancedAsyncTreshhold (int threshholdValue, AsyncThreshholdEdgeType edgeType)
boolean	configAdvancedAsyncAutoSample ()
boolean	configAdvancedAsyncNotEqual (int msTime)
boolean	configAdvancedAsyncDeadBand (int msTime, int deadbandSize)
boolean	configAdvancedAsyncTreshhold (int msTime, int threshholdValue, AsyncThreshholdEdgeType edgeType)
boolean	configAdvancedAsyncAutoSample (int msTime)
boolean	flush ()
int	getConfiguration ()

Private Member Functions
void	fireValueChanged (boolean value)

Private Attributes
ArrayList< IDigitalInputListener >	listeners = new ArrayList<IDigitalInputListener>()

Detailed Description

The Class DigitalInputChannel.

Definition at line 30 of file DigitalInputChannel.java.

Constructor & Destructor Documentation

DigitalInputChannel() [1/4]

com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.DigitalInputChannel	(	DyIOChannel	channel,
		boolean	async
	)

DigitalInputChannel.

Parameters

channel	The channel object to set up as a Digital Input
async	if this should be in async mode

Definition at line 43 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.DyIOChannel.addChannelEventListener(), com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.channel, com.neuronrobotics.sdk.dyio.DyIOChannelMode.DIGITAL_IN, com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.getChannel(), and com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.setMode().

Here is the call graph for this function:

DigitalInputChannel() [2/4]

com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.DigitalInputChannel

(

int

channel

)

Constructor. Creates an counter input input channel that is syncronous only by default.

Parameters

channel

- the channel object requested from the DyIO

Definition at line 57 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.channel, com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.getChannel(), and com.neuronrobotics.sdk.common.DeviceManager.getSpecificDevice().

Here is the call graph for this function:

DigitalInputChannel() [3/4]

com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.DigitalInputChannel	(	DyIO	dyio,
		int	channel
	)

Constructor. Creates an counter input input channel that is syncronous only by default.

Parameters

dyio	the dyio
channel	- the channel object requested from the DyIO

Definition at line 68 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.channel, and com.neuronrobotics.sdk.dyio.DyIO.getChannel().

Here is the call graph for this function:

DigitalInputChannel() [4/4]

com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.DigitalInputChannel

(

DyIOChannel

channel

)

Constructor. Creates an counter input input channel that is syncronous only by default.

Parameters

channel

- the channel object requested from the DyIO

Definition at line 78 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.channel.

Member Function Documentation

addDigitalInputListener()

void com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.addDigitalInputListener

(

IDigitalInputListener

l

)

addDigitalInputListener.

Parameters

l	add the specified listener

Definition at line 127 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.listeners.

fireValueChanged()

void com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.fireValueChanged ( boolean  value )

private

Fire value changed.

Parameters

value

the value

Definition at line 140 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.listeners.

Referenced by com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.onChannelEvent().

hasAsync()

boolean com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.hasAsync

(

)

This method is to check if this peripheral is capable to be set as up as asynchronous.

Returns

if it cna be async

Reimplemented from com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.

Definition at line 158 of file DigitalInputChannel.java.

isHigh()

boolean com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.isHigh

(

)

isHigh.

Returns

Checks to see if the pin is at logic high

Definition at line 87 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.getValue().

Here is the call graph for this function:

onChannelEvent()

void com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.onChannelEvent

(

DyIOChannelEvent

e

)

On channel event.

Parameters

e

the e

Implements com.neuronrobotics.sdk.dyio.IChannelEventListener.

Definition at line 150 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.fireValueChanged(), and com.neuronrobotics.sdk.dyio.DyIOChannelEvent.getUnsignedValue().

Here is the call graph for this function:

removeAllDigitalInputListeners()

void com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.removeAllDigitalInputListeners

(

)

removeAllDigitalInputListeners remove all the listeners.

Definition at line 103 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.listeners.

removeDigitalInputListener()

void com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.removeDigitalInputListener

(

IDigitalInputListener

l

)

removeDigitalInputListener.

Parameters

l	remove the specified listener

Definition at line 113 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.listeners.

setAsync()

void com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.setAsync

(

boolean

isAsync

)

Set the channel to be asynchronous or synchronous.

Parameters

isAsync

- true if the channel should be set to asynchronous and synchronous, false if synchronous only

Reimplemented from com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.

Definition at line 96 of file DigitalInputChannel.java.

References com.neuronrobotics.sdk.dyio.DyIOChannelMode.DIGITAL_IN, and com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.setMode().

Here is the call graph for this function:

Member Data Documentation

listeners

ArrayList<IDigitalInputListener> com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.listeners = new ArrayList<IDigitalInputListener>()

private

The listeners.

Definition at line 33 of file DigitalInputChannel.java.

Referenced by com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.addDigitalInputListener(), com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.fireValueChanged(), com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.removeAllDigitalInputListeners(), and com.neuronrobotics.sdk.dyio.peripherals.DigitalInputChannel.removeDigitalInputListener().

---

The documentation for this class was generated from the following file:

• java-bowler/src/main/java/com/neuronrobotics/sdk/dyio/peripherals/DigitalInputChannel.java