public class sourceice
extends nxm.sys.lib.Primitive
implements nxm.sys.inc.Keyable
| Modifier and Type | Field and Description |
|---|---|
static int |
ATTACH |
static int |
COPY |
static int |
CREATE |
static int |
DETACH |
static int |
DEVICE |
static int |
FILE |
static int |
ICE |
static int |
NET |
static java.lang.String |
pkthdrList |
static java.lang.String |
ptList |
static int |
rABORT |
static int |
rARCHIVE |
static int |
rCONTINUOUS |
static java.lang.String |
replayList |
static int |
rFILE |
static int |
rONESHOT |
static int |
rRESTART |
static int |
rSPIN |
static int |
rSTOPNOW |
static int |
rSTOPPED |
static int |
rSTOPTOP |
static int |
RTFILE |
static int |
SDDS |
static java.lang.String |
sourceList |
static int |
STRIP |
static int |
VRT |
static int |
VRTD |
static int |
VRTL |
static int |
VRTW |
static int |
VRTX |
args, flagsList, id, isPiped, M, MA, MQ, MR, MT, name, option, queue, state, support, threadALAW, AMODE, ASCII, ASCII256, BMAX, BMIN, BOOL, BYTE, COMPLEX, CONVERT_TYPE_LIST, CRAY, DATA_MODE_LIST, DATA_TYPE_LIST, DMAX, DMIN, DOUBLE, EEEI, EXTENDED_DATA_TYPE_LIST, falseStates, FLOAT, FMAX, FMIN, IEEE, IMAX, IMIN, INT, JINT, LMAX, LMIN, LONG, MATRIX, modeList, MULT_DATA_MODE_LIST, NIBBLE, NMAX, NMIN, NONHOMOGENEOUS, NUMBER, numberTypes, NUMERIC_DATA_TYPE_LIST, numericTypeList, OBJECT, PACKED, QUAD, repList, RESULT_TYPE_LIST, SCALAR, STRING, TABLE, TRANSMATRIX, trueStates, typeList, UINT, ULAW, ULONG, VAX, VECTOR, XLONG, XMAX, XMIN, XMODE, XMVALUE, XMVALUE_KVLIST, XMVALUE_LIST, XMVALUE_TABLEANGULAR_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 |
|---|
sourceice() |
| Modifier and Type | Method and Description |
|---|---|
int |
close()
This will finish the commandable objects processing.
|
int |
getCycle() |
java.lang.Object |
getKey(java.lang.String key)
Get the value of an object's keyed field.
|
java.lang.String[] |
getKeys()
Get a list of the available keys.
|
double |
getOffset() |
java.lang.String |
getReplay() |
int |
open()
This will prepare the commandable object for processing.
|
int |
process()
This will process the commandable objects algorithm.
|
void |
setChan(int ichan) |
void |
setEnable(int ena) |
void |
setGain(int gain) |
java.lang.Object |
setKey(java.lang.String key,
java.lang.Object value)
Set the value of an object's keyed field.
|
void |
setReplay(java.lang.String value) |
addProgressFeed, checkin, checkout, finishing, getArgs, getCmdParent, getContext, getID, getInterrupt, getMenuCommands, getMessageHandler, getMidas, getMQ, getMsgID, getName, getPollTime, getProgress, getState, getStatus, getVerbose, isNmPromptCmd, isStateChanged, processException, processMessage, processMessage, processMessages, processReady, restart, run, runSingle, setArg, setArgs, setCmdParent, setMessageHandler, setMsgID, setNmPromptCmd, setPollTime, setProgressFeed, setState, setState, setVerbose, stateToString, thisIsMe, toString, verify, whoIsThispublic static java.lang.String replayList
public static int rFILE
public static int rSTOPPED
public static int rONESHOT
public static int rCONTINUOUS
public static int rSTOPTOP
public static int rSTOPNOW
public static int rSPIN
public static int rARCHIVE
public static int rRESTART
public static int rABORT
public static java.lang.String ptList
public static int ICE
public static int SDDS
public static int VRT
public static int VRTL
public static int VRTW
public static int VRTX
public static int VRTD
public static java.lang.String pkthdrList
public static int STRIP
public static int COPY
public static int ATTACH
public static int DETACH
public static int CREATE
public static java.lang.String sourceList
public static int NET
public static int FILE
public static int RTFILE
public static int DEVICE
public 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 void setReplay(java.lang.String value)
public java.lang.String getReplay()
public int getCycle()
public double getOffset()
public void setGain(int gain)
public void setChan(int ichan)
public void setEnable(int ena)
public java.lang.String[] getKeys()
nxm.sys.inc.KeyablegetKeys in interface nxm.sys.inc.Keyablepublic java.lang.Object setKey(java.lang.String key,
java.lang.Object value)
nxm.sys.inc.KeyablesetKey in interface nxm.sys.inc.Keyablekey - 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.Object getKey(java.lang.String key)
nxm.sys.inc.KeyablegetKey in interface nxm.sys.inc.Keyablekey - The key identifying the value.