BowlerKernel
Public Member Functions | Private Attributes | List of all members
com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink Class Reference
Inheritance diagram for com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink:
Inheritance graph
[legend]
Collaboration diagram for com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink:
Collaboration graph
[legend]

Public Member Functions

 AnalogRotoryLink (AnalogInputChannel c, LinkConfiguration conf)
 
void cacheTargetValueDevice ()
 
void flushDevice (double time)
 
void flushAllDevice (double time)
 
double getCurrentPosition ()
 
void setAnalogChannel (AnalogInputChannel channel)
 
AnalogInputChannel getChannel ()
 
void onAnalogValueChange (AnalogInputChannel chan, double value)
 

Private Attributes

AnalogInputChannel channel
 

Additional Inherited Members

Detailed Description

The Class AnalogRotoryLink.

Definition at line 11 of file AnalogRotoryLink.java.

Constructor & Destructor Documentation

◆ AnalogRotoryLink()

com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.AnalogRotoryLink ( AnalogInputChannel  c,
LinkConfiguration  conf 
)

Instantiates a new analog rotory link.

Parameters
cthe c
confthe conf

Definition at line 22 of file AnalogRotoryLink.java.

References com.neuronrobotics.sdk.addons.kinematics.AbstractLink.conf, and com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.setAnalogChannel().

Here is the call graph for this function:

Member Function Documentation

◆ cacheTargetValueDevice()

void com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.cacheTargetValueDevice ( )

This method is called in order to take the target value and pass it to the implementation's target value This method should not alter the position of the implementations link If the implementation target does not handle chached values, this should be chached in code.

Reimplemented from com.neuronrobotics.sdk.addons.kinematics.AbstractLink.

Definition at line 31 of file AnalogRotoryLink.java.

◆ flushAllDevice()

void com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.flushAllDevice ( double  time)

This method will force one link to update its position in the given time (seconds) This will also flush the host controller.

Parameters
time(seconds) for the position update to take

Reimplemented from com.neuronrobotics.sdk.addons.kinematics.AbstractLink.

Definition at line 47 of file AnalogRotoryLink.java.

◆ flushDevice()

void com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.flushDevice ( double  time)

This method will force one link to update its position in the given time (seconds).

Parameters
time(seconds) for the position update to take

Reimplemented from com.neuronrobotics.sdk.addons.kinematics.AbstractLink.

Definition at line 39 of file AnalogRotoryLink.java.

◆ getChannel()

AnalogInputChannel com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.getChannel ( )

◆ getCurrentPosition()

double com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.getCurrentPosition ( )

This method should return the current position of the link This method is expected to perform a communication with the device .

Returns
the current position of the link

Reimplemented from com.neuronrobotics.sdk.addons.kinematics.AbstractLink.

Definition at line 55 of file AnalogRotoryLink.java.

References com.neuronrobotics.sdk.addons.kinematics.AbstractLink.fireLinkListener(), com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.getChannel(), and com.neuronrobotics.sdk.dyio.peripherals.DyIOAbstractPeripheral.getValue().

Here is the call graph for this function:

◆ onAnalogValueChange()

void com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.onAnalogValueChange ( AnalogInputChannel  chan,
double  value 
)

IAnalogInputListener.

Parameters
chanthe chan
valueThe value of the analog channel is sent to listeners

Implements com.neuronrobotics.sdk.dyio.peripherals.IAnalogInputListener.

Definition at line 86 of file AnalogRotoryLink.java.

References com.neuronrobotics.sdk.addons.kinematics.AbstractLink.fireLinkListener(), and com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.getChannel().

Here is the call graph for this function:

◆ setAnalogChannel()

void com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.setAnalogChannel ( AnalogInputChannel  channel)

Member Data Documentation

◆ channel

AnalogInputChannel com.neuronrobotics.sdk.addons.kinematics.AnalogRotoryLink.channel
private

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