public class list3
extends nxm.sys.lib.GPrimitive
implements nxm.sys.inc.Keyable
args, flagsList, id, isPiped, M, MA, MQ, MR, MT, name, option, queue, state, support, threadANGULAR_VELOCITY_PRECESSING_COR, B1G, B1K, B1M, B1T, B64K, CYC2RAD, DEF_EARTH_ANGULAR_VELOCITY, DEG2METERS, DEG2RAD, E, EARTH_ANGULAR_VELOCITY, EARTH_ECCENTRICITY, EARTH_EQUATORIAL_RADIUS, EARTH_FLATTENING_FACTOR, EARTH_GRAV_CONSTANT_W_ATMOS, EARTH_GRAV_CONSTANT_W_ATMOS_ORIG, EARTH_GRAV_CONSTANT_WO_ATMOS, EARTH_GRAV_CONSTANT_WO_ATMOS_ORIG, FEET2METERS, HALFPI, IAU_EARTH_ANGULAR_VELOCITY, LN2DB, LN2LOG, LNTEN, MASS_OF_EARTH_W_ATMOS, METERS2DEG, METERS2FEET, METERS2NM, METERS2SM, NM2FEET, NM2METERS, PI, POLAR_RADIUS_IN_METERS, POLAR_RADIUS_OF_CURVATURE, RAD2CYC, RAD2DEG, SECOND_EARTH_ECCENTRICITY, SM2FEET, SM2METERS, SPEED_OF_LIGHT, TWOPI| Constructor and Description |
|---|
list3() |
| Modifier and Type | Method and Description |
|---|---|
int |
close()
This will finish the commandable objects processing.
|
java.lang.Object |
getCell(int row,
int col) |
java.lang.Object |
getKey(java.lang.String name)
Get the value of an object's keyed field.
|
java.lang.String[] |
getKeys()
Get a list of the available keys.
|
int |
getPollInterval()
Get the poll interval in seconds
|
int |
open()
This will prepare the commandable object for processing.
|
int |
process()
This will process the commandable objects algorithm.
|
int |
processMessage(nxm.sys.lib.Message msg)
Process a message
|
java.lang.Object |
setKey(java.lang.String name,
java.lang.Object value)
Set the value of an object's keyed field.
|
void |
setPollInterval(int pollInterval)
Set the poll interval in seconds
|
checkout, getGraphicsContainer, getMWindow, getNextLink, getPrevLink, isPipableaddProgressFeed, checkin, finishing, getArgs, getCmdParent, getContext, getID, getInterrupt, getMenuCommands, getMessageHandler, getMidas, getMQ, getMsgID, getName, getPollTime, getProgress, getState, getStatus, getVerbose, isStateChanged, processException, processMessage, processMessages, processReady, restart, run, runSingle, setArg, setArgs, setCmdParent, setMessageHandler, setMsgID, setPollTime, setProgressFeed, setState, setState, setVerbose, stateToString, thisIsMe, toString, verify, whoIsThispublic int open()
nxm.sys.inc.CommandableCommandable.process() and should be used to open
any files needed and to initialize any parameters.open in interface nxm.sys.inc.Commandableopen in class nxm.sys.lib.CommandCommandable.NOOP if this method does no work.Commandable.NORMAL if this method successfully completes and
the Commandable object is ready to be
processed with Commandable.process().Commandable.FINISH if this method successfully completes
and the Commandable object does not require
any processing with Commandable.process() (i.e.
skip directly to Commandable.close()).Commandable.process(),
Commandable.close(),
State Diagram for a Commandable Objectpublic int process()
nxm.sys.inc.CommandableCommandable.open()
method will always be called before this method. This should be
responsible for doing any of the data processing required by the
commandable object.Commandable.NORMAL or Commandable.NOOP.process in interface nxm.sys.inc.Commandableprocess in class nxm.sys.lib.CommandCommandable.NORMAL upon completion of a single pass of the
algorithm.Commandable.FINISH upon successful completion of the entire
algorithm.Commandable.NOOP upon completion of a single pass of the
algorithm in which no work was performed
(this usually indicates that the object is
waiting for another thread to provide data
to process).Commandable.SLEEP upon completion of a single pass of the
algorithm where a pause (see
Time.sleep(double)) is
required before Commandable.process() can be
called again.Commandable.PAUSE
or Commandable.SUSPEND indicates that the Commandable object
should be placed in the Commandable.SUSPEND
state until the Commandable.RESUME
directive is given.Time.sleep(double),
Commandable.open(),
Commandable.close(),
State Diagram for a Commandable Objectpublic int close()
nxm.sys.inc.CommandableCommandable.open() and
Commandable.process(); this includes closing any files opened by
Commandable.open() and clearing any temporary data used by
Commandable.process(). This is the stage where the commandable object
would typically perform any final reporting of data (such as the
setting of RESULTS parameters).close in interface nxm.sys.inc.Commandableclose in class nxm.sys.lib.CommandCommandable.NOOP if this method does no work.Commandable.NORMAL if this method successfully completes.Results,
Commandable.open(),
Commandable.process(),
State Diagram for a Commandable Objectpublic int processMessage(nxm.sys.lib.Message msg)
processMessage in interface nxm.sys.inc.MessageHandlerprocessMessage in class nxm.sys.lib.Commandmsg - The message.Commandable.NORMAL after processing the message or Commandable.NOOP if
the message is not processed.Command.processMessage(String,int,Object)public java.lang.Object getCell(int row,
int col)
public java.lang.Object setKey(java.lang.String name,
java.lang.Object value)
nxm.sys.inc.KeyablesetKey in interface nxm.sys.inc.Keyablename - The key identifying the value.value - The new value to associate with the key.value) or the value that would be returned by Keyable.getKey(String)
immediately after this method call. Since there can be some ambiguity the return value here should
probably be ignored.public java.lang.String[] getKeys()
nxm.sys.inc.KeyablegetKeys in interface nxm.sys.inc.Keyablepublic java.lang.Object getKey(java.lang.String name)
nxm.sys.inc.KeyablegetKey in interface nxm.sys.inc.Keyablename - The key identifying the value.public int getPollInterval()
public void setPollInterval(int pollInterval)
pollInterval - poll interval in seconds