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

Public Member Functions

 LinkConfiguration (Element eElement)
 
 LinkConfiguration (Object[] args)
 
void setVitamin (String name, String type, String id)
 
void setVitaminVariant (String name, String tagValue2)
 
String getVitaminVariant (String name)
 
 LinkConfiguration ()
 
 LinkConfiguration (LinkConfiguration from)
 
 LinkConfiguration (int home, int llimit, int ulimit, double d)
 
String toString ()
 
String getXml ()
 
void setName (String name)
 
String getName ()
 
void setHardwareIndex (int index)
 
int getHardwareIndex ()
 
void setScale (double scale)
 
double getScale ()
 
double getDeviceTheoreticalMax ()
 
void setDeviceTheoreticalMax (double deviceTheoreticalMax)
 
double getDeviceTheoreticalMin ()
 
void setDeviceTheoreticalMin (double deviceTheoreticalMin)
 
void setUpperLimit (double upperLimit)
 
double getUpperLimit ()
 
void setLowerLimit (double lowerLimit)
 
double getLowerLimit ()
 
double getKP ()
 
double getKI ()
 
double getKD ()
 
void setKP (double kP)
 
void setKI (double kI)
 
void setKD (double kD)
 
void setInverted (boolean inverted)
 
boolean isInverted ()
 
void setIndexLatch (double indexLatch)
 
double getIndexLatch ()
 
void setLatch (boolean isLatch)
 
boolean isLatch ()
 
void setStopOnLatch (boolean isStopOnLatch)
 
boolean isStopOnLatch ()
 
void setHomingTicksPerSecond (int homingTicksPerSecond)
 
int getHomingTicksPerSecond ()
 
void setUpperVelocity (double upperVelocity)
 
double getUpperVelocity ()
 
double getLowerVelocity ()
 
int getLinkIndex ()
 
void setLinkIndex (int linkIndex)
 
int getTotlaNumberOfLinks ()
 
void setTotlaNumberOfLinks (int totlaNumberOfLinks)
 
PIDConfiguration getPidConfiguration ()
 
void setPidConfiguration (IPidControlNamespace pid)
 
String getDeviceScriptingName ()
 
void setDeviceScriptingName (String deviceScriptingName)
 
double getStaticOffset ()
 
void setStaticOffset (double staticOffset)
 
boolean isInvertLimitVelocityPolarity ()
 
void setInvertLimitVelocityPolarity (boolean invertVelocity)
 
ArrayList< LinkConfigurationgetSlaveLinks ()
 
void setSlaveLinks (ArrayList< LinkConfiguration > slaveLinks)
 
double getMassKg ()
 
void setMassKg (double mass)
 
TransformNR getCenterOfMassFromCentroid ()
 
void setCenterOfMassFromCentroid (TransformNR com)
 
TransformNR getimuFromCentroid ()
 
void setimuFromCentroid (TransformNR imu)
 
String getElectroMechanicalType ()
 
void setElectroMechanicalType (String electroMechanicalType)
 
String getElectroMechanicalSize ()
 
void setElectroMechanicalSize (String electroMechanicalSize)
 
String getShaftType ()
 
void setShaftType (String shaftType)
 
String getShaftSize ()
 
void setShaftSize (String shaftSize)
 
boolean isPassive ()
 
void setPassive (boolean passive)
 
HashMap< String, String[]> getVitamins ()
 
void setVitamins (HashMap< String, String[]> vitamins)
 
String getTypeString ()
 
void setTypeString (String typeString)
 
boolean isVirtual ()
 
boolean isTool ()
 
boolean isPrismatic ()
 
void addChangeListener (ILinkConfigurationChangeListener l)
 
void removeChangeListener (ILinkConfigurationChangeListener l)
 
void clearChangeListener ()
 
ArrayList< ILinkConfigurationChangeListenergetListeners ()
 
void event (TransformNR changed)
 
boolean isPauseEvents ()
 
void setPauseEvents (boolean pauseEvents)
 

Protected Member Functions

void getVitamins (Element doc)
 

Private Member Functions

String[] getCoreShaftPart ()
 
String[] getCoreEmPart ()
 

Private Attributes

ArrayList< ILinkConfigurationChangeListenerlisteners = null
 
boolean pauseEvents =false
 
String name = "newLink"
 
String type = "virtual"
 
int index = 0
 
int totlaNumberOfLinks = 1
 
int linkIndex = 0
 
double scale = 1.0
 
double upperLimit = 100000
 
double lowerLimit = -100000
 
double k [] = new double[] { 1, 0, 0 }
 
boolean inverted = false
 
boolean isLatch = false
 
double indexLatch = 0
 
boolean isStopOnLatch = false
 
int homingTicksPerSecond = 10000000
 
double velocityLimit = 100000000
 
String deviceScriptingName = "exampleDevice"
 
double deviceTheoreticalMax = 180
 
double deviceTheoreticalMin = 0
 
double mass = 0.01
 
TransformNR centerOfMassFromCentroid = new TransformNR()
 
TransformNR imuFromCentroid = new TransformNR()
 
double staticOffset = 0
 
ArrayList< LinkConfigurationslaveLinks = new ArrayList<LinkConfiguration>()
 
boolean invertVelocity = false
 
boolean invertLimitVelocityPolarity = false
 
HashMap< String, String[]> vitamins = new HashMap<String, String[]>()
 
HashMap< String, String > vitaminVariant = new HashMap<String, String>()
 
boolean passive = false
 
boolean newAbs = false
 

Detailed Description

The Class LinkConfiguration.

Definition at line 25 of file LinkConfiguration.java.

Constructor & Destructor Documentation

◆ LinkConfiguration() [1/5]

com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration ( Element  eElement)

Instantiates a new link configuration.

Parameters
eElementthe e element

Definition at line 109 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.common.Log.error(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getHardwareIndex(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getLowerLimit(), com.neuronrobotics.sdk.addons.kinematics.xml.XmlFactory.getTagValue(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getTypeString(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getUpperLimit(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getVitamins(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.inverted, com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.invertLimitVelocityPolarity, com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isLatch, com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isStopOnLatch, com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.k, com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.newAbs, com.neuronrobotics.sdk.addons.kinematics.LinkType.PID, com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setCenterOfMassFromCentroid(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setDeviceScriptingName(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setDeviceTheoreticalMax(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setDeviceTheoreticalMin(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setElectroMechanicalSize(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setElectroMechanicalType(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setHardwareIndex(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setHomingTicksPerSecond(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setimuFromCentroid(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setIndexLatch(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setLowerLimit(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setMassKg(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setName(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setPassive(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setScale(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setShaftSize(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setShaftType(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setStaticOffset(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setTypeString(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setUpperLimit(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setUpperVelocity(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.staticOffset, and com.neuronrobotics.sdk.addons.kinematics.LinkType.VIRTUAL.

Here is the call graph for this function:

◆ LinkConfiguration() [2/5]

com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration ( Object[]  args)

◆ LinkConfiguration() [3/5]

com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration ( )

Instantiates a new link configuration.

Definition at line 339 of file LinkConfiguration.java.

Referenced by com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration().

◆ LinkConfiguration() [4/5]

com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration ( LinkConfiguration  from)

Definition at line 343 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getCenterOfMassFromCentroid(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getDeviceScriptingName(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getDeviceTheoreticalMax(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getDeviceTheoreticalMin(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getHardwareIndex(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getHomingTicksPerSecond(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getimuFromCentroid(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getIndexLatch(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getLowerLimit(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getMassKg(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getName(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getScale(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getStaticOffset(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getTypeString(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getUpperLimit(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getUpperVelocity(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getVitamins(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isLatch, com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isPassive(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isStopOnLatch, com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setCenterOfMassFromCentroid(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setDeviceScriptingName(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setDeviceTheoreticalMax(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setDeviceTheoreticalMin(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setHardwareIndex(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setHomingTicksPerSecond(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setimuFromCentroid(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setIndexLatch(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setLatch(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setLowerLimit(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setMassKg(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setName(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setPassive(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setScale(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setStaticOffset(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setStopOnLatch(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setTypeString(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setUpperLimit(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setUpperVelocity(), and com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.slaveLinks.

Here is the call graph for this function:

◆ LinkConfiguration() [5/5]

com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration ( int  home,
int  llimit,
int  ulimit,
double  d 
)

Member Function Documentation

◆ addChangeListener()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.addChangeListener ( ILinkConfigurationChangeListener  l)

◆ clearChangeListener()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.clearChangeListener ( )

◆ event()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.event ( TransformNR  changed)

◆ getCenterOfMassFromCentroid()

TransformNR com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getCenterOfMassFromCentroid ( )

◆ getCoreEmPart()

String [] com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getCoreEmPart ( )
private

◆ getCoreShaftPart()

String [] com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getCoreShaftPart ( )
private

◆ getDeviceScriptingName()

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getDeviceScriptingName ( )

◆ getDeviceTheoreticalMax()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getDeviceTheoreticalMax ( )

◆ getDeviceTheoreticalMin()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getDeviceTheoreticalMin ( )

◆ getElectroMechanicalSize()

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getElectroMechanicalSize ( )

Definition at line 976 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getCoreEmPart().

Here is the call graph for this function:

◆ getElectroMechanicalType()

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getElectroMechanicalType ( )

Definition at line 967 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getCoreEmPart().

Here is the call graph for this function:

◆ getHardwareIndex()

int com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getHardwareIndex ( )

◆ getHomingTicksPerSecond()

int com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getHomingTicksPerSecond ( )

◆ getimuFromCentroid()

TransformNR com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getimuFromCentroid ( )

◆ getIndexLatch()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getIndexLatch ( )

◆ getKD()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getKD ( )

◆ getKI()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getKI ( )

◆ getKP()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getKP ( )

◆ getLinkIndex()

int com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getLinkIndex ( )

THis is the index of this link in its kinematics chain.

Returns
the link index

Definition at line 782 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.linkIndex.

Referenced by com.neuronrobotics.bowlerstudio.creature.MobileBaseCadManager._generateStls().

◆ getListeners()

ArrayList<ILinkConfigurationChangeListener> com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getListeners ( )

◆ getLowerLimit()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getLowerLimit ( )

◆ getLowerVelocity()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getLowerVelocity ( )

Gets the lower velocity.

Returns
the lower velocity

Definition at line 773 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.velocityLimit.

Referenced by com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getXml().

◆ getMassKg()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getMassKg ( )

◆ getName()

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getName ( )

◆ getPidConfiguration()

PIDConfiguration com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getPidConfiguration ( )

◆ getScale()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getScale ( )

◆ getShaftSize()

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getShaftSize ( )

Definition at line 994 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getCoreShaftPart().

Here is the call graph for this function:

◆ getShaftType()

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getShaftType ( )

Definition at line 985 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getCoreShaftPart().

Here is the call graph for this function:

◆ getSlaveLinks()

ArrayList<LinkConfiguration> com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getSlaveLinks ( )

◆ getStaticOffset()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getStaticOffset ( )

◆ getTotlaNumberOfLinks()

int com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getTotlaNumberOfLinks ( )

Gets the totla number of links.

Returns
the totla number of links

Definition at line 801 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.totlaNumberOfLinks.

Referenced by com.neuronrobotics.sdk.addons.kinematics.LinkFactory.LinkFactory().

◆ getTypeString()

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getTypeString ( )

◆ getUpperLimit()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getUpperLimit ( )

◆ getUpperVelocity()

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getUpperVelocity ( )

◆ getVitamins() [1/2]

HashMap<String, String[]> com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getVitamins ( )

◆ getVitamins() [2/2]

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getVitamins ( Element  doc)
protected

◆ getVitaminVariant()

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getVitaminVariant ( String  name)

◆ getXml()

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getXml ( )

Gets the xml.

Returns
the xml

Definition at line 418 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.deviceScriptingName, com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getCenterOfMassFromCentroid(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getDeviceScriptingName(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getDeviceTheoreticalMax(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getDeviceTheoreticalMin(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getHardwareIndex(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getHomingTicksPerSecond(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getimuFromCentroid(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getIndexLatch(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getLowerLimit(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getLowerVelocity(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getMassKg(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getName(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getScale(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getStaticOffset(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getTypeString(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getUpperLimit(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getUpperVelocity(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getVitamins(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getVitaminVariant(), com.neuronrobotics.sdk.addons.kinematics.math.TransformNR.getXml(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isLatch, com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isPassive(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isStopOnLatch, and com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.slaveLinks.

Referenced by com.neuronrobotics.sdk.addons.kinematics.DHParameterKinematics.getEmbedableXml().

Here is the call graph for this function:

◆ isInverted()

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isInverted ( )

◆ isInvertLimitVelocityPolarity()

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isInvertLimitVelocityPolarity ( )

◆ isLatch()

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isLatch ( )

Checks if is latch.

Returns
true, if is latch

Definition at line 698 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isLatch.

◆ isPassive()

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isPassive ( )

◆ isPauseEvents()

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isPauseEvents ( )

◆ isPrismatic()

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isPrismatic ( )

◆ isStopOnLatch()

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isStopOnLatch ( )

Checks if is stop on latch.

Returns
true, if is stop on latch

Definition at line 717 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isStopOnLatch.

◆ isTool()

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isTool ( )

Checks if is tool.

Returns
true, if is tool

Definition at line 1057 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getTypeString().

Referenced by com.neuronrobotics.sdk.addons.kinematics.DHParameterKinematics.addNewLink().

Here is the call graph for this function:

◆ isVirtual()

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isVirtual ( )

Checks if is virtual.

Returns
true, if is virtual

Definition at line 1037 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getTypeString().

Here is the call graph for this function:

◆ removeChangeListener()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.removeChangeListener ( ILinkConfigurationChangeListener  l)

◆ setCenterOfMassFromCentroid()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setCenterOfMassFromCentroid ( TransformNR  com)

◆ setDeviceScriptingName()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setDeviceScriptingName ( String  deviceScriptingName)

◆ setDeviceTheoreticalMax()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setDeviceTheoreticalMax ( double  deviceTheoreticalMax)

◆ setDeviceTheoreticalMin()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setDeviceTheoreticalMin ( double  deviceTheoreticalMin)

◆ setElectroMechanicalSize()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setElectroMechanicalSize ( String  electroMechanicalSize)

◆ setElectroMechanicalType()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setElectroMechanicalType ( String  electroMechanicalType)

◆ setHardwareIndex()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setHardwareIndex ( int  index)

sets the hardware index for maping this kinematics link to its assocaited hardware index.

Parameters
indexthe new hardware index

Definition at line 479 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.index.

Referenced by com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration().

◆ setHomingTicksPerSecond()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setHomingTicksPerSecond ( int  homingTicksPerSecond)

◆ setimuFromCentroid()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setimuFromCentroid ( TransformNR  imu)

◆ setIndexLatch()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setIndexLatch ( double  indexLatch)

◆ setInverted()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setInverted ( boolean  inverted)

Sets the inverted.

Parameters
invertedthe new inverted

Definition at line 646 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.inverted.

◆ setInvertLimitVelocityPolarity()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setInvertLimitVelocityPolarity ( boolean  invertVelocity)

◆ setKD()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setKD ( double  kD)

Sets the kd.

Parameters
kDthe new kd

Definition at line 636 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.k.

◆ setKI()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setKI ( double  kI)

Sets the ki.

Parameters
kIthe new ki

Definition at line 626 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.k.

◆ setKP()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setKP ( double  kP)

Sets the kp.

Parameters
kPthe new kp

Definition at line 616 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.k.

◆ setLatch()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setLatch ( boolean  isLatch)

◆ setLinkIndex()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setLinkIndex ( int  linkIndex)

This sets the index of the link in itts kinematic chain.

Parameters
linkIndexthe new link index

Definition at line 791 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.linkIndex.

Referenced by com.neuronrobotics.sdk.addons.kinematics.AbstractKinematicsNR.setDevice().

◆ setLowerLimit()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setLowerLimit ( double  lowerLimit)

◆ setMassKg()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setMassKg ( double  mass)

◆ setName()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setName ( String  name)

◆ setPassive()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setPassive ( boolean  passive)

◆ setPauseEvents()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setPauseEvents ( boolean  pauseEvents)

◆ setPidConfiguration()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setPidConfiguration ( IPidControlNamespace  pid)

◆ setScale()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setScale ( double  scale)

◆ setShaftSize()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setShaftSize ( String  shaftSize)

◆ setShaftType()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setShaftType ( String  shaftType)

◆ setSlaveLinks()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setSlaveLinks ( ArrayList< LinkConfiguration slaveLinks)

◆ setStaticOffset()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setStaticOffset ( double  staticOffset)

◆ setStopOnLatch()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setStopOnLatch ( boolean  isStopOnLatch)

Sets the stop on latch.

Parameters
isStopOnLatchthe new stop on latch

Definition at line 707 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isStopOnLatch.

Referenced by com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration().

◆ setTotlaNumberOfLinks()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setTotlaNumberOfLinks ( int  totlaNumberOfLinks)

Sets the totla number of links.

Parameters
totlaNumberOfLinksthe new totla number of links

Definition at line 810 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.totlaNumberOfLinks.

Referenced by com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration().

◆ setTypeString()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setTypeString ( String  typeString)

◆ setUpperLimit()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setUpperLimit ( double  upperLimit)

◆ setUpperVelocity()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setUpperVelocity ( double  upperVelocity)

◆ setVitamin()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setVitamin ( String  name,
String  type,
String  id 
)

Add a vitamin to this link

Parameters
namethe name of this vitamin, if the name already exists, the data will be overwritten.
typethe vitamin type, this maps the the json filename
idthe part ID, theis maps to the key in the json for the vitamin

Definition at line 306 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getVitamins(), com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.name, and com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.type.

Referenced by com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getVitamins().

Here is the call graph for this function:

◆ setVitamins()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setVitamins ( HashMap< String, String[]>  vitamins)

◆ setVitaminVariant()

void com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setVitaminVariant ( String  name,
String  tagValue2 
)

Set a purchasing code for a vitamin

Parameters
namename of vitamin
tagValue2Purchaning code

Definition at line 321 of file LinkConfiguration.java.

References com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.name, and com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.vitaminVariant.

Referenced by com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.getVitamins().

◆ toString()

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.toString ( )

Member Data Documentation

◆ centerOfMassFromCentroid

TransformNR com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.centerOfMassFromCentroid = new TransformNR()
private

◆ deviceScriptingName

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.deviceScriptingName = "exampleDevice"
private

◆ deviceTheoreticalMax

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.deviceTheoreticalMax = 180
private

◆ deviceTheoreticalMin

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.deviceTheoreticalMin = 0
private

◆ homingTicksPerSecond

int com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.homingTicksPerSecond = 10000000
private

◆ imuFromCentroid

TransformNR com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.imuFromCentroid = new TransformNR()
private

◆ index

int com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.index = 0
private

◆ indexLatch

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.indexLatch = 0
private

◆ inverted

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.inverted = false
private

◆ invertLimitVelocityPolarity

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.invertLimitVelocityPolarity = false
private

This is the flag for setting the direction of the velocity lock out for limit switches

Definition at line 97 of file LinkConfiguration.java.

Referenced by com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isInvertLimitVelocityPolarity(), and com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.LinkConfiguration().

◆ invertVelocity

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.invertVelocity = false
private

This is the flag for setting the direction of the velocity lock out for limit switches

Definition at line 91 of file LinkConfiguration.java.

Referenced by com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.setInvertLimitVelocityPolarity().

◆ isLatch

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isLatch = false
private

◆ isStopOnLatch

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.isStopOnLatch = false
private

◆ k

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.k[] = new double[] { 1, 0, 0 }
private

◆ linkIndex

int com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.linkIndex = 0
private

◆ listeners

ArrayList<ILinkConfigurationChangeListener> com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.listeners = null
private

◆ lowerLimit

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.lowerLimit = -100000
private

◆ mass

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.mass = 0.01
private

◆ name

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.name = "newLink"
private

◆ newAbs

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.newAbs = false
private

◆ passive

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.passive = false
private

◆ pauseEvents

boolean com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.pauseEvents =false
private

◆ scale

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.scale = 1.0
private

◆ slaveLinks

ArrayList<LinkConfiguration> com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.slaveLinks = new ArrayList<LinkConfiguration>()
private

◆ staticOffset

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.staticOffset = 0
private

◆ totlaNumberOfLinks

int com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.totlaNumberOfLinks = 1
private

◆ type

String com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.type = "virtual"
private

◆ upperLimit

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.upperLimit = 100000
private

◆ velocityLimit

double com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.velocityLimit = 100000000
private

◆ vitamins

HashMap<String, String[]> com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.vitamins = new HashMap<String, String[]>()
private

◆ vitaminVariant

HashMap<String, String> com.neuronrobotics.sdk.addons.kinematics.LinkConfiguration.vitaminVariant = new HashMap<String, String>()
private

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