|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.yobotics.simulationconstructionset.YoVariable
public abstract class YoVariable
Title: Yobotics! Simulation Construction Set
Description: Package for Simulating Dynamic Robots and Mechanisms
YoVariables provide a simple, convienent mechanism for storing and manipulating robot data. While each essentially contains a double value YoVariables are designed for integration into the SCS GUI. Once registered, a variable will automatically become available to the GUI for graphing, modification and other data manipulation. Historical values of all registered YoVariables are stored in the DataBuffer which may be exported for later use.
Copyright: Copyright (c) 2000-2011Company: Yobotics, Inc. and IHMC
Field Summary | |
---|---|
static int |
MAX_LENGTH_SHORT_NAME
|
Constructor Summary | |
---|---|
YoVariable()
|
Method Summary | |
---|---|
void |
addVariableChangedListener(VariableChangedListener variableChangedListener)
|
boolean |
fullNameEndsWithCaseInsensitive(java.lang.String name)
fullNameEndsWith |
java.lang.String |
getDescription()
Retrieve the description of this variable, "" if not specified. |
java.lang.String |
getFullNameWithNameSpace()
|
double |
getManualScalingMax()
Retrieve the current maximum value for manual scaling. |
double |
getManualScalingMin()
Retrieve the current minimum value for manual scaling. |
java.lang.String |
getName()
Retrieves the name of this YoVariable. |
void |
getName(java.lang.StringBuffer buffer)
Adds the name of this variable to the provided string buffer. |
void |
getNameAndValueString(java.lang.StringBuffer stringBuffer)
Adds the variables name & value to the beginning of the given string buffer |
void |
getNameAndValueStringFromDouble(java.lang.StringBuffer stringBuffer,
double doubleValue)
|
NameSpace |
getNameSpace()
|
java.lang.String |
getNumericValueAsAString()
|
java.lang.String |
getShortName()
Retrieves a shortened version of this variables name. |
abstract double |
getValueAsDouble()
|
abstract void |
getValueString(java.lang.StringBuffer stringBuffer)
|
abstract void |
getValueStringFromDouble(java.lang.StringBuffer stringBuffer,
double value)
|
java.util.ArrayList<VariableChangedListener> |
getVariableChangedListeners()
|
YoVariableRegistry |
getYoVariableRegistry()
|
abstract YoVariableType |
getYoVariableType()
|
boolean |
hasSameFullName(YoVariable variable)
hasSameFullName |
void |
notifyVariableChangedListeners()
|
void |
removeAllVariableChangedListeners()
|
void |
removeVariableChangedListener(VariableChangedListener variableChangedListener)
|
void |
setManualScalingMinMax(double minScaling,
double maxScaling)
Set the min and max scaling values for graphing purposes. |
abstract void |
setValueFromDouble(double value)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int MAX_LENGTH_SHORT_NAME
Constructor Detail |
---|
public YoVariable()
Method Detail |
---|
public YoVariableRegistry getYoVariableRegistry()
public java.lang.String getName()
public java.lang.String getShortName()
public java.lang.String getDescription()
public void getName(java.lang.StringBuffer buffer)
buffer
- StringBuffer to which the name will be added at the beginningpublic void setManualScalingMinMax(double minScaling, double maxScaling)
minScaling
- double representing the min scale valuemaxScaling
- double representing the max scale valuepublic double getManualScalingMin()
public double getManualScalingMax()
public void getNameAndValueString(java.lang.StringBuffer stringBuffer)
stringBuffer
- StringBuffer to which the data will be addedpublic void getNameAndValueStringFromDouble(java.lang.StringBuffer stringBuffer, double doubleValue)
public boolean fullNameEndsWithCaseInsensitive(java.lang.String name)
name
- String
public boolean hasSameFullName(YoVariable variable)
variable
- YoVariable
public java.lang.String getFullNameWithNameSpace()
public NameSpace getNameSpace()
public void addVariableChangedListener(VariableChangedListener variableChangedListener)
public void removeAllVariableChangedListeners()
public java.util.ArrayList<VariableChangedListener> getVariableChangedListeners()
public void removeVariableChangedListener(VariableChangedListener variableChangedListener)
public void notifyVariableChangedListeners()
public java.lang.String getNumericValueAsAString()
public abstract YoVariableType getYoVariableType()
public abstract double getValueAsDouble()
public abstract void setValueFromDouble(double value)
public abstract void getValueString(java.lang.StringBuffer stringBuffer)
public abstract void getValueStringFromDouble(java.lang.StringBuffer stringBuffer, double value)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |