public abstract class ScriptParam extends ScriptError
| Modifier and Type | Field and Description |
|---|---|
java.util.Map<java.lang.String,SV> |
contextVariables |
boolean |
coordinatesAreFractional |
javajs.util.P3 |
fractionalPoint |
boolean |
isBondSet |
int |
iToken |
javajs.util.P3 |
pt1 |
javajs.util.P3 |
pt2 |
javajs.util.P3 |
pt3 |
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 |
|---|---|
javajs.util.P3 |
atomCenterOrCoordinateParameter(int i,
java.lang.Object[] ret) |
javajs.util.P3 |
centerParameter(int i,
java.lang.Object[] ret) |
protected javajs.util.P3 |
centerParameterForModel(int i,
int modelIndex,
java.lang.Object[] ret) |
int |
checkLast(int i) |
int |
checkLength(int length) |
int |
checkLength23() |
protected int |
checkLength34() |
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,
boolean isLocal) |
(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() |
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 % 7) << 5
+ (m % 0x1F)
|
private static int |
getPartialBondOrderFromString(java.lang.String s) |
javajs.util.P3 |
getPoint3f(int i,
boolean allowFractional,
boolean throwE) |
javajs.util.P4 |
getPoint4f(int i) |
javajs.util.P3[] |
getPointArray(int i,
int nPoints,
boolean allowNull)
may return null values in some cases
|
javajs.util.Lst<javajs.util.P3> |
getPointOrCenterVector(T t) |
java.lang.Object |
getPointOrPlane(int index,
boolean integerOnly,
boolean allowFractional,
boolean doConvert,
boolean implicitFractional,
int minDim,
int maxDim,
boolean throwE) |
javajs.util.Lst<javajs.util.P3> |
getPointVector(T t,
int i) |
javajs.util.Quat |
getQuaternionParameter(int i,
javajs.util.BS bsAtoms,
boolean divideByCurrent) |
T |
getToken(int i) |
protected java.lang.Object |
getVarParameter(java.lang.String var,
boolean orReturnName) |
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) |
javajs.util.Lst<java.lang.Object> |
listParameter4(int i,
int nMin,
int nMax,
boolean allowString) |
int |
modelNumberParameter(int index) |
java.lang.String |
objectNameParameter(int index) |
java.lang.String |
optParameterAsString(int i) |
java.lang.String |
paramAsStr(int i) |
javajs.util.P4 |
planeParameter(int i) |
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) |
javajs.util.P4 |
xyzpParameter(int index) |
bad, error, errorMore, errorStr, errorStr2, errorString, evalError, getErrorLineMessage, getErrorMessage, getErrorMessageUntranslated, integerOutOfRange, invArg, numberOutOfRange, setCursorWait, setErrorMessage, showStringPrint, warningclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcheckScriptSilent, checkSelect, compileScriptFile, compileScriptString, deleteAtomsInVariables, evalFunctionFloat, evalParallel, evaluateCompiledScript, evaluateExpression, getAllowJSThreads, getAtomBitSet, getNextStatement, getScript, getScriptContext, getThisContext, haltExecution, isExecuting, isPaused, isStateScript, isStepping, isStopped, loadFileResourceAsync, notifyResumeStatus, pauseExecution, pushContextDown, resumeEval, resumePausedExecution, runScript, runScriptBuffer, setCompiler, setDebugging, setObjectPropSafe, setStatic, setViewer, stepPausedExecution, stopScriptThreadspublic 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
public javajs.util.P3 fractionalPoint
public boolean coordinatesAreFractional
public boolean isBondSet
public javajs.util.P3 pt1
public javajs.util.P3 pt2
public javajs.util.P3 pt3
public T getToken(int i) throws ScriptException
ScriptExceptionpublic 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.Object getVarParameter(java.lang.String var,
boolean orReturnName)
public SV getContextVariableAsVariable(java.lang.String var, boolean isLocal)
public java.lang.String paramAsStr(int i)
throws ScriptException
ScriptExceptionpublic java.lang.String stringParameter(int index)
throws ScriptException
ScriptExceptionpublic java.lang.String[] stringParameterSet(int i)
throws ScriptException
ScriptExceptionpublic java.lang.String objectNameParameter(int index)
throws ScriptException
ScriptExceptionpublic javajs.util.P3 atomCenterOrCoordinateParameter(int i,
java.lang.Object[] ret)
throws ScriptException
i - ret - return P3 or BS to ret[0]; on input, passing a BS as ret[1]
indicates that it should be ANDED with this BS prior to calculation
(SHOW/DRAW SYMOP)ScriptExceptionpublic boolean isCenterParameter(int i)
public javajs.util.P3 centerParameter(int i,
java.lang.Object[] ret)
throws ScriptException
ScriptExceptionprotected javajs.util.P3 centerParameterForModel(int i,
int modelIndex,
java.lang.Object[] ret)
throws ScriptException
ScriptExceptionpublic javajs.util.P4 planeParameter(int i)
throws ScriptException
ScriptExceptionpublic javajs.util.Lst<javajs.util.P3> getPointOrCenterVector(T t) throws ScriptException
ScriptExceptionpublic javajs.util.P4 hklParameter(int i)
throws ScriptException
ScriptExceptionpublic javajs.util.P4 getHklPlane(javajs.util.P3 pt)
public java.lang.Object getPointOrPlane(int index,
boolean integerOnly,
boolean allowFractional,
boolean doConvert,
boolean implicitFractional,
int minDim,
int maxDim,
boolean throwE)
throws ScriptException
ScriptExceptionpublic boolean isPoint3f(int i)
public javajs.util.P3 getPoint3f(int i,
boolean allowFractional,
boolean throwE)
throws ScriptException
ScriptExceptionpublic javajs.util.P4 getPoint4f(int i)
throws ScriptException
ScriptExceptionpublic javajs.util.P3 xypParameter(int index)
throws ScriptException
ScriptExceptionpublic javajs.util.P4 xyzpParameter(int index)
throws ScriptException
ScriptExceptionpublic java.lang.String optParameterAsString(int i)
throws ScriptException
ScriptExceptionpublic int intParameter(int index)
throws ScriptException
ScriptExceptionpublic boolean isFloatParameter(int index)
public float floatParameter(int index)
throws ScriptException
ScriptExceptionpublic javajs.util.P3[] getPointArray(int i,
int nPoints,
boolean allowNull)
throws ScriptException
i - nPoints - -1 for unspecified number of pointsallowNull - if allowing null values (as in setting atom properties such as vxyz or xyz)ScriptExceptionpublic javajs.util.Lst<java.lang.Object> listParameter(int i,
int nMin,
int nMax)
throws ScriptException
ScriptExceptionpublic javajs.util.Lst<java.lang.Object> listParameter4(int i,
int nMin,
int nMax,
boolean allowString)
throws ScriptException
ScriptExceptionpublic float[] floatParameterSet(int i,
int nMin,
int nMax)
throws ScriptException
i - nMin - nMax - ScriptExceptionpublic boolean isArrayParameter(int i)
public javajs.util.Quat getQuaternionParameter(int i,
javajs.util.BS bsAtoms,
boolean divideByCurrent)
throws ScriptException
ScriptExceptionpublic int checkLast(int i)
throws ScriptException
ScriptExceptionpublic int checkLength(int length)
throws ScriptException
ScriptExceptionpublic int checkLengthErrorPt(int length,
int errorPt)
throws ScriptException
ScriptExceptionpublic int checkLength23()
throws ScriptException
ScriptExceptionprotected int checkLength34()
throws ScriptException
ScriptExceptionpublic int modelNumberParameter(int index)
throws ScriptException
ScriptExceptionpublic int getMadParameter()
throws ScriptException
ScriptExceptionpublic int intParameterRange(int i,
int min,
int max)
throws ScriptException
ScriptExceptionprotected float floatParameterRange(int i,
float min,
float max)
throws ScriptException
ScriptExceptionpublic javajs.util.Lst<javajs.util.P3> getPointVector(T t, int i) throws ScriptException
ScriptExceptionstatic 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
ScriptExceptionprotected int getArgbParamLast(int index,
boolean allowNone)
throws ScriptException
ScriptExceptionprotected int getArgbParamOrNone(int index,
boolean allowNone)
throws ScriptException
ScriptExceptionprivate int getColorTriad(int i)
throws ScriptException
ScriptExceptionpublic TickInfo tickParamAsStr(int index, boolean allowUnitCell, boolean allowScale, boolean allowFirst) throws ScriptException
index - allowUnitCell - IGNOREDallowScale - allowFirst - ScriptExceptionpublic 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)