Package org.jmol.script

Class ScriptVariable

java.lang.Object

org.jmol.script.Token

org.jmol.script.ScriptVariable

Direct Known Subclasses:

ScriptVariableInt

public class ScriptVariable
extends Token

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ScriptVariable.Sort

Field Summary

Fields

Modifier and Type	Field	Description
int	index

Fields inherited from class org.jmol.script.Token

adpmax, adpmin, all, allfloat, allowembeddedscripts, allowgestures, allowkeystrokes, allowmodelkit, allowmoveatoms, allowmultitouch, allowrotateselected, altloc, ambientpercent, angle, animationfps, antialiasdisplay, antialiasimages, antialiastranslucent, appendnew, appletproxy, applysymmetrytobonds, array, atomid, atomindex, atomname, atomno, atompicking, atomproperty, atoms, atomtype, atomtypes, atomx, atomy, atomz, auto, autobond, autofps, average, axes, axescolor, axesmode, axesmolecular, axesorientationrasmol, axesscale, axesunitcell, axeswindow, axis, axis1color, axis2color, axis3color, backbone, backgroundcolor, backgroundmodel, backlit, basepair, bitset, bondcount, bondmodeor, bondpicking, bondradiusmilliangstroms, bonds, bondtolerance, booleanparam, boundbox, boundboxcolor, branch, brillouin, cameradepth, cap, carbohydrate, cartoon, cartoonbaseedges, cartoonfancy, cartoonrockets, cell, center, chain, chaincasesensitive, clash, color, colorrasmol, configuration, connect, connected, contact, contourlines, covalent, create, cross, currentlocalpath, data, dataseparator, debug, debugscript, decimal, defaultanglelabel, defaultcolorscheme, defaultdirectory, defaultdistancelabel, defaultdrawarrowscale, defaultdropscript, defaultlabelpdb, defaultlabelxyz, defaultlattice, defaultloadfilter, defaultloadscript, defaults, defaultstructuredssp, defaulttorsionlabel, defaulttranslucent, defaultvdw, define, delaymaximumms, delete, depth, diffusepercent, dipole, dipolescale, disablepopupmenu, display, displaycellparameters, distance, dna, dotdensity, dots, dotscale, dotsselectedonly, dotsurface, dragselected, draw, drawhover, drawpicking, dsspcalchydrogen, dynamicmeasurements, echo, edsurlcutoff, edsurlformat, element, elemisono, elemno, ellipsoid, ellipsoidarcs, ellipsoidaxes, ellipsoidaxisdiameter, ellipsoidball, ellipsoiddotcount, ellipsoiddots, ellipsoidfill, energyunits, eta, file, filecachedirectory, filecaching, fill, first, floatparam, floatproperty, fontcaching, fontscaling, forceautobond, forcefield, formalcharge, format, fractionalrelative, fracx, fracxyz, fracy, fracz, frank, front, frontlit, frontonly, full, fullylit, fux, fuxyz, fuy, fuz, geosurface, gestureswipefactor, greyscalerendering, group, group1, groupid, groupindex, halo, hbond, hbondsangleminimum, hbondsbackbone, hbondsdistancemaximum, hbondsrasmol, hbondssolid, helix, helixstep, helppath, hermitelevel, hetero, hidenameinpopup, hidenavigationpoint, hidenotselected, highlight, highresolution, historylevel, hover, hoverdelay, hoverlabel, hydrogen, hydrophobic, identifier, identify, imagestate, info, insertion, integer, intermolecular, intparam, intproperty, intramolecular, intValue, ionic, isaromatic, iskiosk, isosurface, isosurfacekey, isosurfacepropertysmoothing, isosurfacepropertysmoothingpower, jmol, justifymeasurements, label, language, languagetranslation, last, lcaocartoon, left, legacyautobonding, list, loadatomdatatolerance, loadformat, loadligandformat, logcommands, logfile, loggestures, loglevel, mass, matrix3f, matrix4f, max, measure, measureallmodels, measurementlabels, measurements, measurementunits, mesh, meshRibbon, meshscale, messagestylechime, min, minbonddistance, minimizationcriterion, minimizationrefresh, minimizationsilent, minimizationsteps, minpixelselradius, mo, model, modelindex, modelkitmode, modify, modifyorcreate, molecule, monitorenergy, mousedragfactor, mousewheelfactor, moveto, multiplebondradiusfactor, multiplebondspacing, multiprocessor, nada, navfps, navigate, navigatesurface, navigationdepth, navigationmode, navigationperiodic, navigationslab, navigationspeed, navx, navy, navz, nci, next, nmrurlformat, nocontourlines, nodots, nofill, nomesh, none, notfrontonly, notriangles, nucleic, occupancy, off, omega, on, opEQ, opToggle, partialcharge, partialdots, path, pathforallfiles, pause, pdbaddhydrogens, pdbgetheader, pdbsequential, percent, percentvdwatom, perspectivedepth, perspectivemodel, phi, phongexponent, picking, pickingspinrate, pickingstyle, picklabel, plane, play, playrev, plot3d, pmesh, point, pointgroupdistancetolerance, pointgrouplineartolerance, polyhedra, polymer, polymerlength, preservestate, prev, probe, property, propertyatomnumbercolumncount, propertyatomnumberfield, propertycolorscheme, propertydatacolumncount, propertydatafield, PROPERTYFLAGS, protein, psi, purine, pyrimidine, quaternionframe, radius, range, rangeselected, rasmol, redomove, refreshing, repaintwaitms, residue, resno, resume, reverse, rewind, ribbon, ribbonaspectratio, ribbonborder, right, rna, rocket, rocketbarrels, rotate, rotation, rotationradius, sasurface, save, saveproteinstructurestate, scaleangstromsperinch, screenx, screenxyz, screeny, screenz, scriptCommand, scriptqueue, scriptreportinglevel, selectallmodels, selected, selectedfloat, selecthetero, selecthydrogen, selectionhalos, sequence, shape, sheet, sheetsmoothing, showaxes, showboundbox, showfrank, showhiddenselectionhalos, showhydrogens, showkeystrokes, showmeasurements, showmultiplebonds, shownavigationpointalways, showscript, showtiming, showunitcell, sidechain, site, slab, slabbyatom, slabbymolecule, slabenabled, slabrange, smallmoleculemaxatoms, smartaromatic, smiles2dimageformat, smilesurlformat, solvent, solventprobe, solventproberadius, spacefill, spec_alternate, spec_atom, spec_chain, spec_model, spec_name_pattern, spec_resid, spec_seqcode, spec_seqcode_range, specialposition, specular, specularexponent, specularpercent, specularpower, sphere, spine, spinfps, spinx, spiny, spinz, ssbond, ssbondsbackbone, star, statusreporting, stddev, stereodegrees, straightness, strandcount, strandcountformeshribbon, strandcountforstrands, strands, string, strparam, strproperty, strucid, strucno, structure, strutdefaultradius, strutlengthmaximum, struts, strutsmultiple, strutspacing, substructure, sum, sum2, surface, surfacedistance, symbol, symmetry, symop, syncmouse, syncscript, temperature, testflag1, testflag2, testflag3, testflag4, theta, tok, tokenAnd, tokenAND, tokenAndFALSE, tokenComma, tokenConnected, tokenExpressionBegin, tokenExpressionEnd, tokenLeftParen, tokenOpIf, tokenOr, tokenOrTRUE, tokenRightParen, trace, tracealpha, trajectory, translate, translation, translucent, triangles, trim, trycmd, type, undo, undomove, unitcell, unitcellcolor, unitx, unitxyz, unity, unitz, usearcball, useminimizationthread, usenumberlocalization, usercolorscheme, valence, value, vanderwaals, vector, vectorscale, vectorsymmetry, vibration, vibrationperiod, vibrationscale, vibx, vibxyz, viby, vibz, visualrange, volume, waitformoveto, windowcentered, wireframe, wireframerotation, within, x, xyz, y, z, zdepth, zerobasedxyzrasmol, zoomenabled, zoomlarge, zshade, zshadepower, zslab

Constructor Summary

Constructors

Constructor	Description
ScriptVariable(int tok)

Method Summary

Modifier and Type	Method	Description
static boolean	areEqual(ScriptVariable x1, ScriptVariable x2)
boolean	asBoolean()
float	asFloat()
int	asInt()
java.lang.String	asString()
static BitSet	bsSelectRange(Token x, int n)
static BitSet	bsSelectToken(Token x)
static BitSet	bsSelectVar(ScriptVariable var)
boolean	canIncrement()
static ScriptVariable	concatList(ScriptVariable x1, ScriptVariable x2, boolean asNew)
java.lang.String	escape()
static float[]	flistValue(Token x, int nMin)
static float	fValue(Token x)
static BitSet	getBitSet(ScriptVariable x, boolean allowNull)
static ScriptVariable	getBoolean(boolean value)
java.util.List<ScriptVariable>	getList()
static ScriptVariable	getVariable(java.lang.Object x)
static ScriptVariable	getVariableAD(double[] f)
static ScriptVariable	getVariableAF(float[] f)
static ScriptVariable	getVariableAFF(float[][] fx)
static ScriptVariable	getVariableAI(int[] ix)
static ScriptVariable	getVariableAII(int[][] ix)
static ScriptVariable	getVariableAP(Point3f[] p)
static ScriptVariable	getVariableAS(java.lang.String[] s)
static ScriptVariable	getVariableAV(ScriptVariable[] v)
static ScriptVariable	getVariableList(java.util.List<?> v)
static ScriptVariable	getVariableMap(java.lang.Object x)
boolean	increment(int n)
static boolean	isVariableType(java.lang.Object x)
static int	iValue(Token x)
static java.lang.String[]	listValue(Token x)
ScriptVariable	mapValue(java.lang.String key)
static ScriptVariable	newScriptVariableBs(BitSet bs, int index)
static ScriptVariable	newScriptVariableIntValue(int tok, int intValue, java.lang.Object value)
static ScriptVariable	newScriptVariableToken(Token x)
static ScriptVariable	newVariable(int tok, java.lang.Object value)
static java.lang.Object	nValue(Token x)
static java.lang.Object	oValue(ScriptVariable x)
static Point4f	pt4Value(ScriptVariable x)
static Point3f	ptValue(ScriptVariable x)
static Token	selectItemTok(Token var)
static Token	selectItemTok(Token tokenIn, int i2)
static ScriptVariable	selectItemVar(ScriptVariable var)
static ScriptVariable	selectItemVar2(ScriptVariable var, int i2)
ScriptVariable	set(ScriptVariable v, boolean asCopy)	creates a NEW version of the variable
ScriptVariable	setGlobal()
ScriptVariable	setName(java.lang.String name)
boolean	setSelectedValue(int selector, ScriptVariable var)
static int	sizeOf(Token x)
ScriptVariable	sortOrReverse(int arrayPt)
static java.lang.Object	sprintf(java.lang.String strFormat, ScriptVariable var)
static java.lang.String	sprintfArray(ScriptVariable[] args)	sprintf accepts arguments from the format() function First argument is a format string.
static java.lang.String	sValue(Token x)
void	toArray()
java.lang.String	toString()
static java.lang.String	typeOf(ScriptVariable x)
static BitSet	unEscapeBitSetArray(java.util.ArrayList<ScriptVariable> x, boolean allowNull)
boolean	unEscapeBitSetArray(BitSet bs)
static java.lang.Object	unescapePointOrBitsetAsVariable(java.lang.Object o)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class org.jmol.script.Token

addToken, completeCommand, getAtomPropertiesLike, getCommandSet, getParamType, getSettableTokFromString, getTokenFromName, getTokensLike, getTokFromName, intToken, nameOf, newToken, newTokenIntVal, newTokenObj, tokAttr, tokAttrOr

Field Detail

index

public int index

Constructor Detail

ScriptVariable

public ScriptVariable(int tok)

Method Detail

newVariable

public static ScriptVariable newVariable(int tok,
                                         java.lang.Object value)

newScriptVariableBs

public static ScriptVariable newScriptVariableBs(BitSet bs,
                                                 int index)

newScriptVariableToken

public static ScriptVariable newScriptVariableToken(Token x)

newScriptVariableIntValue

public static ScriptVariable newScriptVariableIntValue(int tok,
                                                       int intValue,
                                                       java.lang.Object value)

typeOf

public static java.lang.String typeOf(ScriptVariable x)

sizeOf

public static int sizeOf(Token x)

isVariableType

public static boolean isVariableType(java.lang.Object x)

getVariable

public static ScriptVariable getVariable(java.lang.Object x)

Parameters:

x -

Returns:

a ScriptVariable of the input type, or if x is null, then a new ScriptVariable, or, if the type is not found, a string version

getVariableMap

public static ScriptVariable getVariableMap(java.lang.Object x)

getVariableList

public static ScriptVariable getVariableList(java.util.List<?> v)

getVariableAV

public static ScriptVariable getVariableAV(ScriptVariable[] v)

getVariableAD

public static ScriptVariable getVariableAD(double[] f)

getVariableAS

public static ScriptVariable getVariableAS(java.lang.String[] s)

getVariableAP

public static ScriptVariable getVariableAP(Point3f[] p)

getVariableAFF

public static ScriptVariable getVariableAFF(float[][] fx)

getVariableAII

public static ScriptVariable getVariableAII(int[][] ix)

getVariableAF

public static ScriptVariable getVariableAF(float[] f)

getVariableAI

public static ScriptVariable getVariableAI(int[] ix)

set

public ScriptVariable set(ScriptVariable v,
                          boolean asCopy)

creates a NEW version of the variable

Parameters:

v -

asCopy - create a new set of object pointers for an array; copies an associative array

Returns:

new ScriptVariable

setName

public ScriptVariable setName(java.lang.String name)

setGlobal

public ScriptVariable setGlobal()

canIncrement

public boolean canIncrement()

increment

public boolean increment(int n)

asBoolean

public boolean asBoolean()

asInt

public int asInt()

asFloat

public float asFloat()

asString

public java.lang.String asString()

oValue

public static java.lang.Object oValue(ScriptVariable x)

Parameters:

x -

Returns:

Object-wrapped value

nValue

public static java.lang.Object nValue(Token x)

Parameters:

x -

Returns:

numeric value -- integer or decimal

iValue

public static int iValue(Token x)

fValue

public static float fValue(Token x)

sValue

public static java.lang.String sValue(Token x)

ptValue

public static Point3f ptValue(ScriptVariable x)

pt4Value

public static Point4f pt4Value(ScriptVariable x)

concatList

public static ScriptVariable concatList(ScriptVariable x1,
                                        ScriptVariable x2,
                                        boolean asNew)

bsSelectToken

public static BitSet bsSelectToken(Token x)

bsSelectVar

public static BitSet bsSelectVar(ScriptVariable var)

bsSelectRange

public static BitSet bsSelectRange(Token x,
                                   int n)

selectItemVar

public static ScriptVariable selectItemVar(ScriptVariable var)

selectItemTok

public static Token selectItemTok(Token var)

selectItemVar2

public static ScriptVariable selectItemVar2(ScriptVariable var,
                                            int i2)

selectItemTok

public static Token selectItemTok(Token tokenIn,
                                  int i2)

setSelectedValue

public boolean setSelectedValue(int selector,
                                ScriptVariable var)

escape

public java.lang.String escape()

unescapePointOrBitsetAsVariable

public static java.lang.Object unescapePointOrBitsetAsVariable(java.lang.Object o)

getBoolean

public static ScriptVariable getBoolean(boolean value)

sprintf

public static java.lang.Object sprintf(java.lang.String strFormat,
                                       ScriptVariable var)

sprintfArray

public static java.lang.String sprintfArray(ScriptVariable[] args)

sprintf accepts arguments from the format() function First argument is a format string.

Parameters:

args -

Returns:

formatted string

toString

public java.lang.String toString()

Overrides:

toString in class Token

getBitSet

public static BitSet getBitSet(ScriptVariable x,
                               boolean allowNull)

areEqual

public static boolean areEqual(ScriptVariable x1,
                               ScriptVariable x2)

sortOrReverse

public ScriptVariable sortOrReverse(int arrayPt)

Parameters:

arrayPt - 1-based or Integer.MIN_VALUE to reverse

Returns:

sorted or reversed array

unEscapeBitSetArray

public boolean unEscapeBitSetArray(BitSet bs)

unEscapeBitSetArray

public static BitSet unEscapeBitSetArray(java.util.ArrayList<ScriptVariable> x,
                                         boolean allowNull)

listValue

public static java.lang.String[] listValue(Token x)

flistValue

public static float[] flistValue(Token x,
                                 int nMin)

toArray

public void toArray()

mapValue

public ScriptVariable mapValue(java.lang.String key)

getList

public java.util.List<ScriptVariable> getList()