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

Public Member Functions

 PidPrismaticLink (PIDChannel c, LinkConfiguration conf, boolean b)
 
void cacheTargetValueDevice ()
 
void flushDevice (double time)
 
void flushAllDevice (double time)
 
double getCurrentPosition ()
 
void setPIDChannel (PIDChannel channel)
 
PIDChannel getPIDChannel ()
 

Private Attributes

PIDChannel channel
 

Additional Inherited Members

Detailed Description

The Class PidPrismaticLink.

Definition at line 12 of file PidPrismaticLink.java.

Constructor & Destructor Documentation

◆ PidPrismaticLink()

com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.PidPrismaticLink ( PIDChannel  c,
LinkConfiguration  conf,
boolean  b 
)

Member Function Documentation

◆ cacheTargetValueDevice()

void com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.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 42 of file PidPrismaticLink.java.

References com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.channel, com.neuronrobotics.sdk.addons.kinematics.AbstractLink.getTargetValue(), and com.neuronrobotics.sdk.pid.PIDChannel.setCachedTargetValue().

Here is the call graph for this function:

◆ flushAllDevice()

void com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.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 59 of file PidPrismaticLink.java.

References com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.channel, com.neuronrobotics.sdk.addons.kinematics.AbstractLink.fireLinkListener(), com.neuronrobotics.sdk.namespace.bcs.pid.IPidControlNamespace.flushPIDChannels(), com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.getCurrentPosition(), and com.neuronrobotics.sdk.pid.PIDChannel.getPid().

Here is the call graph for this function:

◆ flushDevice()

void com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.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 50 of file PidPrismaticLink.java.

References com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.channel, com.neuronrobotics.sdk.addons.kinematics.AbstractLink.fireLinkListener(), com.neuronrobotics.sdk.pid.PIDChannel.flush(), and com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.getCurrentPosition().

Here is the call graph for this function:

◆ getCurrentPosition()

double com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.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 69 of file PidPrismaticLink.java.

References com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.channel, and com.neuronrobotics.sdk.pid.PIDChannel.GetPIDPosition().

Referenced by com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.flushAllDevice(), and com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.flushDevice().

Here is the call graph for this function:

◆ getPIDChannel()

PIDChannel com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.getPIDChannel ( )

Gets the PID channel.

Returns
the PID channel

Definition at line 100 of file PidPrismaticLink.java.

References com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.channel.

◆ setPIDChannel()

void com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.setPIDChannel ( PIDChannel  channel)

Member Data Documentation

◆ channel

PIDChannel com.neuronrobotics.sdk.addons.kinematics.PidPrismaticLink.channel
private

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