public abstract class ScriptParam extends ScriptError
Modifier and Type | Field and Description |
---|---|
java.util.Map<java.lang.String,SV> |
contextVariables |
protected boolean |
coordinatesAreFractional |
java.lang.Object |
expressionResult |
protected javajs.util.P3 |
fractionalPoint |
boolean |
isBondSet |
int |
iToken |
int |
slen |
T[] |
st |
int |
theTok |
T |
theToken |
ScriptContext |
thisContext |
chk, error, ERROR_axisExpected, ERROR_backgroundModelError, ERROR_badArgumentCount, ERROR_badMillerIndices, ERROR_badRGBColor, ERROR_booleanExpected, ERROR_booleanOrNumberExpected, ERROR_booleanOrWhateverExpected, ERROR_cannotSet, ERROR_colorExpected, ERROR_colorOrPaletteRequired, ERROR_commandExpected, ERROR_coordinateOrNameOrExpressionRequired, ERROR_drawObjectNotDefined, ERROR_endOfStatementUnexpected, ERROR_expressionExpected, ERROR_expressionOrIntegerExpected, ERROR_filenameExpected, ERROR_fileNotFoundException, ERROR_incompatibleArguments, ERROR_insufficientArguments, ERROR_integerExpected, ERROR_integerOutOfRange, ERROR_invalidArgument, ERROR_invalidParameterOrder, ERROR_keywordExpected, ERROR_moCoefficients, ERROR_moIndex, ERROR_moModelError, ERROR_moOccupancy, ERROR_moOnlyOne, ERROR_multipleModelsDisplayedNotOK, ERROR_multipleModelsNotOK, ERROR_noData, ERROR_noPartialCharges, ERROR_noUnitCell, ERROR_numberExpected, ERROR_numberMustBe, ERROR_numberOutOfRange, ERROR_objectNameExpected, ERROR_planeExpected, ERROR_propertyNameExpected, ERROR_spaceGroupNotFound, ERROR_stringExpected, ERROR_stringOrIdentifierExpected, ERROR_tooManyPoints, ERROR_tooManyScriptLevels, ERROR_unrecognizedAtomProperty, ERROR_unrecognizedBondProperty, ERROR_unrecognizedCommand, ERROR_unrecognizedExpression, ERROR_unrecognizedObject, ERROR_unrecognizedParameter, ERROR_unrecognizedParameterWarning, ERROR_unrecognizedShowParameter, ERROR_what, ERROR_writeWhat, errorMessage, errorMessageUntranslated, errorType, iCommandError, ignoreError, vwr
Constructor and Description |
---|
ScriptParam() |
Modifier and Type | Method and Description |
---|---|
protected javajs.util.P3 |
atomCenterOrCoordinateParameter(int i) |
abstract BS |
atomExpression(T[] code,
int pcStart,
int pcStop,
boolean allowRefresh,
boolean allowUnderflow,
boolean mustBeBitSet,
boolean andNotDeleted) |
abstract BS |
atomExpressionAt(int i) |
javajs.util.P3 |
centerParameter(int i) |
protected javajs.util.P3 |
centerParameterForModel(int i,
int modelIndex) |
int |
checkLast(int i) |
int |
checkLength(int length) |
int |
checkLength23() |
protected int |
checkLength34() |
protected int |
checkLengthErrorPt(int length,
int errorPt) |
protected boolean |
checkToken(int i) |
float |
floatParameter(int index) |
protected float |
floatParameterRange(int i,
float min,
float max) |
float[] |
floatParameterSet(int i,
int nMin,
int nMax)
process a general string or set of parameters as an array of floats,
allowing for relatively free form input
|
int |
getArgbParam(int index) |
protected int |
getArgbParamLast(int index,
boolean allowNone) |
protected int |
getArgbParamOrNone(int index,
boolean allowNone) |
static int |
getBondOrderFromString(java.lang.String s) |
private int |
getColorTriad(int i) |
SV |
getContextVariableAsVariable(java.lang.String var) |
(package private) static int |
getFloatEncodedInt(java.lang.String strDecimal)
Encodes a string such as "2.10" as an integer instead of a float so as to
distinguish "2.1" from "2.10" used for model numbers and partial bond
orders.
|
javajs.util.P4 |
getHklPlane(javajs.util.P3 pt) |
int |
getMadParameter() |
protected abstract javajs.util.P3 |
getObjectCenter(java.lang.String id,
int index,
int modelIndex) |
java.lang.Object |
getParameter(java.lang.String key,
int tokType,
boolean nullAsString) |
static int |
getPartialBondOrderFromFloatEncodedInt(int bondOrderInteger)
reads standard n.m float-as-integer n*1000000 + m and returns (n % 6) << 5
+ (m % 0x1F)
|
private static int |
getPartialBondOrderFromString(java.lang.String s) |
protected abstract javajs.util.P4 |
getPlaneForObject(java.lang.String id,
javajs.util.V3 vAB) |
javajs.util.P3 |
getPoint3f(int i,
boolean allowFractional) |
javajs.util.P4 |
getPoint4f(int i) |
javajs.util.P3[] |
getPointArray(int i,
int nPoints,
boolean allowNull)
may return null values in some cases
|
protected java.lang.Object |
getPointOrPlane(int index,
boolean integerOnly,
boolean allowFractional,
boolean doConvert,
boolean implicitFractional,
int minDim,
int maxDim) |
javajs.util.Lst<javajs.util.P3> |
getPointVector(T t,
int i) |
javajs.util.Quat |
getQuaternionParameter(int i) |
protected java.lang.String |
getStringParameter(java.lang.String var,
boolean orReturnName) |
T |
getToken(int i) |
javajs.util.P4 |
hklParameter(int i) |
int |
intParameter(int index) |
int |
intParameterRange(int i,
int min,
int max) |
boolean |
isArrayParameter(int i) |
boolean |
isCenterParameter(int i) |
boolean |
isColorParam(int i) |
boolean |
isFloatParameter(int index) |
boolean |
isPoint3f(int i) |
javajs.util.Lst<java.lang.Object> |
listParameter(int i,
int nMin,
int nMax) |
int |
modelNumberParameter(int index) |
java.lang.String |
objectNameParameter(int index) |
java.lang.String |
optParameterAsString(int i) |
java.lang.String |
paramAsStr(int i) |
protected abstract javajs.util.Lst<SV> |
parameterExpressionList(int pt,
int ptAtom,
boolean isArrayItem) |
javajs.util.P4 |
planeParameter(int i) |
protected abstract void |
restrictSelected(boolean isBond,
boolean doInvert) |
void |
setBooleanProperty(java.lang.String key,
boolean value) |
protected boolean |
setFloatProperty(java.lang.String key,
float value) |
protected boolean |
setIntProperty(java.lang.String key,
int value) |
protected void |
setStringProperty(java.lang.String key,
java.lang.String value) |
java.lang.String |
stringParameter(int index) |
java.lang.String[] |
stringParameterSet(int i) |
TickInfo |
tickParamAsStr(int index,
boolean allowUnitCell,
boolean allowScale,
boolean allowFirst) |
int |
tokAt(int i) |
javajs.util.P3 |
xypParameter(int index) |
bad, error, errorMore, errorStr, errorStr2, errorString, evalError, getErrorLineMessage, getErrorMessage, getErrorMessageUntranslated, integerOutOfRange, invArg, numberOutOfRange, setCursorWait, setErrorMessage, showString, warning
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
checkScriptSilent, checkSelect, compileScriptFile, compileScriptString, deleteAtomsInVariables, evalFunctionFloat, evalParallel, evaluateCompiledScript, evaluateExpression, getAllowJSThreads, getAtomBitSet, getAtomBitSetVector, getContextVariables, getDefinedAtomSets, getNextStatement, getScript, getScriptContext, getThisContext, haltExecution, isExecuting, isPaused, isStateScript, isStepping, isStopped, loadFileResourceAsync, notifyResumeStatus, pauseExecution, pushContextDown, resumeEval, resumePausedExecution, runScript, runScriptBuffer, setCompiler, setDebugging, setObjectPropSafe, setViewer, stepPausedExecution, stopScriptThreads
public java.util.Map<java.lang.String,SV> contextVariables
public ScriptContext thisContext
public int iToken
public int theTok
public T theToken
public T[] st
public int slen
protected javajs.util.P3 fractionalPoint
protected boolean coordinatesAreFractional
public boolean isBondSet
public java.lang.Object expressionResult
public abstract BS atomExpressionAt(int i) throws ScriptException
ScriptException
public abstract BS atomExpression(T[] code, int pcStart, int pcStop, boolean allowRefresh, boolean allowUnderflow, boolean mustBeBitSet, boolean andNotDeleted) throws ScriptException
ScriptException
protected abstract javajs.util.P3 getObjectCenter(java.lang.String id, int index, int modelIndex)
protected abstract javajs.util.P4 getPlaneForObject(java.lang.String id, javajs.util.V3 vAB)
protected abstract javajs.util.Lst<SV> parameterExpressionList(int pt, int ptAtom, boolean isArrayItem) throws ScriptException
ScriptException
protected abstract void restrictSelected(boolean isBond, boolean doInvert)
public T getToken(int i) throws ScriptException
ScriptException
public int tokAt(int i)
protected boolean checkToken(int i)
public java.lang.Object getParameter(java.lang.String key, int tokType, boolean nullAsString)
protected java.lang.String getStringParameter(java.lang.String var, boolean orReturnName)
public SV getContextVariableAsVariable(java.lang.String var)
public java.lang.String paramAsStr(int i) throws ScriptException
ScriptException
public java.lang.String stringParameter(int index) throws ScriptException
ScriptException
public java.lang.String[] stringParameterSet(int i) throws ScriptException
ScriptException
public java.lang.String objectNameParameter(int index) throws ScriptException
ScriptException
protected javajs.util.P3 atomCenterOrCoordinateParameter(int i) throws ScriptException
i
- ScriptException
public boolean isCenterParameter(int i)
public javajs.util.P3 centerParameter(int i) throws ScriptException
ScriptException
protected javajs.util.P3 centerParameterForModel(int i, int modelIndex) throws ScriptException
ScriptException
public javajs.util.P4 planeParameter(int i) throws ScriptException
ScriptException
public javajs.util.P4 hklParameter(int i) throws ScriptException
ScriptException
public javajs.util.P4 getHklPlane(javajs.util.P3 pt)
protected java.lang.Object getPointOrPlane(int index, boolean integerOnly, boolean allowFractional, boolean doConvert, boolean implicitFractional, int minDim, int maxDim) throws ScriptException
ScriptException
public boolean isPoint3f(int i)
public javajs.util.P3 getPoint3f(int i, boolean allowFractional) throws ScriptException
ScriptException
public javajs.util.P4 getPoint4f(int i) throws ScriptException
ScriptException
public javajs.util.P3 xypParameter(int index) throws ScriptException
ScriptException
public java.lang.String optParameterAsString(int i) throws ScriptException
ScriptException
public int intParameter(int index) throws ScriptException
ScriptException
public boolean isFloatParameter(int index)
public float floatParameter(int index) throws ScriptException
ScriptException
public javajs.util.P3[] getPointArray(int i, int nPoints, boolean allowNull) throws ScriptException
i
- nPoints
- allowNull
- if allowing null values (as in setting atom properties such as vxyz or xyz)ScriptException
public javajs.util.Lst<java.lang.Object> listParameter(int i, int nMin, int nMax) throws ScriptException
ScriptException
public float[] floatParameterSet(int i, int nMin, int nMax) throws ScriptException
i
- nMin
- nMax
- ScriptException
public boolean isArrayParameter(int i)
public javajs.util.Quat getQuaternionParameter(int i) throws ScriptException
ScriptException
public int checkLast(int i) throws ScriptException
ScriptException
public int checkLength(int length) throws ScriptException
ScriptException
protected int checkLengthErrorPt(int length, int errorPt) throws ScriptException
ScriptException
public int checkLength23() throws ScriptException
ScriptException
protected int checkLength34() throws ScriptException
ScriptException
public int modelNumberParameter(int index) throws ScriptException
ScriptException
public int getMadParameter() throws ScriptException
ScriptException
public int intParameterRange(int i, int min, int max) throws ScriptException
ScriptException
protected float floatParameterRange(int i, float min, float max) throws ScriptException
ScriptException
public javajs.util.Lst<javajs.util.P3> getPointVector(T t, int i) throws ScriptException
ScriptException
static int getFloatEncodedInt(java.lang.String strDecimal)
strDecimal
- public static int getPartialBondOrderFromFloatEncodedInt(int bondOrderInteger)
bondOrderInteger
- public static int getBondOrderFromString(java.lang.String s)
private static int getPartialBondOrderFromString(java.lang.String s)
public boolean isColorParam(int i)
public int getArgbParam(int index) throws ScriptException
ScriptException
protected int getArgbParamLast(int index, boolean allowNone) throws ScriptException
ScriptException
protected int getArgbParamOrNone(int index, boolean allowNone) throws ScriptException
ScriptException
private int getColorTriad(int i) throws ScriptException
ScriptException
public TickInfo tickParamAsStr(int index, boolean allowUnitCell, boolean allowScale, boolean allowFirst) throws ScriptException
index
- allowUnitCell
- IGNOREDallowScale
- allowFirst
- ScriptException
public void setBooleanProperty(java.lang.String key, boolean value)
protected boolean setIntProperty(java.lang.String key, int value)
protected boolean setFloatProperty(java.lang.String key, float value)
protected void setStringProperty(java.lang.String key, java.lang.String value)