com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic Class Reference

Inheritance diagram for com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic:

Collaboration diagram for com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic:

Public Member Functions
	GcodePrismatic (LinkConfiguration conf, GcodeDevice device, String linkAxis)
void	cacheTargetValueDevice ()
void	flushDevice (double time)
void	flushAllDevice (double time)
double	getCurrentPosition ()
String	getAxis ()
void	setAxis (String axis)
double	getValue ()
void	setValue (double value)
Public Member Functions inherited from com.neuronrobotics.sdk.addons.kinematics.AbstractPrismaticLink
	AbstractPrismaticLink (LinkConfiguration conf)
void	incrementDisplacment (double inc)
void	setTargetDisplacment (double pos)
void	setCurrentAsDisplacment (double Displacment)
double	getCurrentDisplacment ()
double	getTargetDisplacment ()
double	getMaxDisplacment ()
double	getMinDisplacment ()
boolean	isMaxDisplacment ()
boolean	isMinDisplacment ()
Public Member Functions inherited from com.neuronrobotics.sdk.addons.kinematics.AbstractLink
double	getDeviceMaximumValue ()
double	getDeviceMinimumValue ()
void	setDeviceMaximumValue (double max)
void	setDeviceMinimumValue (double min)
double	getDeviceMaxEngineeringUnits ()
double	getDeviceMinEngineeringUnits ()
	AbstractLink (LinkConfiguration conf)
void	cacheTargetValue ()
void	flush (double time)
void	flushAll (double time)
double	toEngineeringUnits (double value)
double	toLinkUnits (double euValue)
void	addLinkListener (ILinkListener l)
void	removeLinkListener (ILinkListener l)
void	fireLinkListener (double linkUnitsValue)
void	fireLinkLimitEvent (PIDLimitEvent e)
void	Home ()
void	incrementEngineeringUnits (double inc)
void	setTargetEngineeringUnits (double pos)
void	setCurrentEngineeringUnits (double angle)
double	getCurrentEngineeringUnits ()
double	getTargetEngineeringUnits ()
double	getMaxEngineeringUnits ()
double	getMinEngineeringUnits ()
void	setMinEngineeringUnits (double minLimit)
void	setMaxEngineeringUnits (double maxLimit)
double	getMaxVelocityEngineeringUnits ()
void	setMaxVelocityEngineeringUnits (double max)
boolean	isMaxEngineeringUnits ()
boolean	isMinEngineeringUnits ()
double	getTargetValue ()
void	setUpperLimit (int upperLimit)
void	setLowerLimit (int lowerLimit)
void	setHome (int home)
void	setScale (double d)
double	getScale ()
double	getUpperLimit ()
double	getLowerLimit ()
double	getHome ()
void	setCurrentAsUpperLimit ()
void	setCurrentAsLowerLimit ()
void	setUseLimits (boolean useLimits)
boolean	isUseLimits ()
void	setLinkConfiguration (LinkConfiguration conf)
LinkConfiguration	getLinkConfiguration ()
ArrayList< ILinkListener >	getLinks ()
void	setLinks (ArrayList< ILinkListener > links)
void	removeAllLinkListener ()
void	setGlobalPositionListener (Object Object)
Object	getGlobalPositionListener ()
LinkFactory	getSlaveFactory ()
void	setSlaveFactory (LinkFactory slaveFactory)
IMU	getImu ()
void	addChangeListener (ILinkConfigurationChangeListener l)
void	removeChangeListener (ILinkConfigurationChangeListener l)
void	clearChangeListener ()

Private Member Functions
void	loadCurrent ()

Private Attributes
GcodeDevice	device
String	axis = ""
double	value =0

Additional Inherited Members
Protected Member Functions inherited from com.neuronrobotics.sdk.addons.kinematics.AbstractLink
void	setPosition (double val)
void	setTargetValue (double val)

Detailed Description

Definition at line 6 of file GcodePrismatic.java.

Constructor & Destructor Documentation

GcodePrismatic()

com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.GcodePrismatic	(	LinkConfiguration	conf,
		GcodeDevice	device,
		String	linkAxis
	)

Definition at line 10 of file GcodePrismatic.java.

References com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.axis, com.neuronrobotics.sdk.addons.kinematics.AbstractLink.conf, and com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.device.

Member Function Documentation

cacheTargetValueDevice()

void com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.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 19 of file GcodePrismatic.java.

flushAllDevice()

void com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.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 39 of file GcodePrismatic.java.

References com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.device, and com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodeDevice.flush().

Here is the call graph for this function:

flushDevice()

void com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.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 28 of file GcodePrismatic.java.

References com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.device, com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.getAxis(), com.neuronrobotics.sdk.addons.kinematics.AbstractLink.getTargetValue(), com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.getValue(), com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.loadCurrent(), and com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodeDevice.runLine().

Here is the call graph for this function:

getAxis()

String com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.getAxis

(

)

Return the gcode axis of this channel

Returns

the axis

Implements com.neuronrobotics.sdk.addons.kinematics.gcodebridge.IGCodeChannel.

Definition at line 49 of file GcodePrismatic.java.

References com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.axis.

Referenced by com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.flushDevice().

getCurrentPosition()

double com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.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 44 of file GcodePrismatic.java.

References com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.getValue().

Here is the call graph for this function:

getValue()

double com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.getValue

(

)

Definition at line 57 of file GcodePrismatic.java.

References com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.value.

Referenced by com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.flushDevice(), and com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.getCurrentPosition().

loadCurrent()

void com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.loadCurrent ( )

private

Definition at line 23 of file GcodePrismatic.java.

References com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.device, and com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodeDevice.loadCurrent().

Referenced by com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.flushDevice().

Here is the call graph for this function:

setAxis()

void com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.setAxis

(

String

axis

)

Definition at line 53 of file GcodePrismatic.java.

References com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.axis.

setValue()

void com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.setValue

(

double

value

)

Set a value of the current position

Parameters

value

of the current psition

Implements com.neuronrobotics.sdk.addons.kinematics.gcodebridge.IGCodeChannel.

Definition at line 61 of file GcodePrismatic.java.

References com.neuronrobotics.sdk.addons.kinematics.AbstractLink.fireLinkListener(), and com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.value.

Here is the call graph for this function:

Member Data Documentation

axis

String com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.axis = ""

private

Definition at line 8 of file GcodePrismatic.java.

Referenced by com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.GcodePrismatic(), com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.getAxis(), and com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.setAxis().

device

GcodeDevice com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.device

private

Definition at line 7 of file GcodePrismatic.java.

Referenced by com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.flushAllDevice(), com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.flushDevice(), com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.GcodePrismatic(), and com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.loadCurrent().

value

double com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.value =0

private

Definition at line 9 of file GcodePrismatic.java.

Referenced by com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.getValue(), and com.neuronrobotics.sdk.addons.kinematics.gcodebridge.GcodePrismatic.setValue().

---

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

• java-bowler/src/main/java/com/neuronrobotics/sdk/addons/kinematics/gcodebridge/GcodePrismatic.java