public final class sinkpic extends nxm.sys.lib.Primitive implements PicSlave, nxm.sys.inc.Keyable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
algorithmList |
static java.lang.String |
monitorList |
static java.lang.String |
replayList |
static java.lang.String |
syncList |
static java.lang.String |
throttleList |
args, flagsList, id, isPiped, M, MA, MD, MQ, MR, MT, name, option, queue, state, support, thread
ALAW, ASCII, BMAX, BMIN, BOOL, BYTE, COMPLEX, CONVERT_TYPE_LIST, CRAY, DATA_MODE_LIST, DATA_TYPE_LIST, DMAX, DMIN, DOUBLE, EEEI, falseStates, FLOAT, FMAX, FMIN, IEEE, IMAX, IMIN, INT, LMAX, LMIN, LONG, MATRIX, modeList, MULT_DATA_MODE_LIST, NIBBLE, NMAX, NMIN, NONHOMOGENEOUS, NUMBER, NUMERIC_DATA_TYPE_LIST, numericTypeList, OBJECT, PACKED, QUAD, repList, RESULT_TYPE_LIST, SCALAR, STRING, TABLE, TRANSMATRIX, trueStates, typeList, ULAW, VAX, VECTOR, XLONG, XMAX, XMIN, XMODE, XMVALUE, XMVALUE_KVLIST, XMVALUE_LIST, XMVALUE_TABLE
ANGULAR_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 |
---|
sinkpic() |
Modifier and Type | Method and Description |
---|---|
int |
close()
This will finish the commandable objects processing.
|
int |
getCBLost() |
int |
getCycle() |
int |
getDec() |
MDevIce |
getDevIce() |
int |
getDmaMode() |
double |
getFreq() |
int |
getGain() |
int |
getHBLost() |
long |
getIndex() |
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.
|
java.lang.String |
getMonitor() |
double |
getOffset() |
int |
getPFull() |
double |
getProgress()
returns the 0->1 progress based on input file
|
int |
getRate() |
java.lang.String |
getReplay() |
int |
getSkip() |
nxm.sys.lib.Time |
getTime() |
DevIce.TimeCode |
getTimeCode() |
int |
open()
This will prepare the commandable object for processing.
|
int |
process()
This will process the commandable objects algorithm.
|
void |
setDec(int value) |
void |
setFreq(double value) |
void |
setGain(int value) |
java.lang.Object |
setKey(java.lang.String key,
java.lang.Object value)
Set the value of an object's keyed field.
|
void |
setMonitor(java.lang.String value) |
void |
setRate(int value) |
void |
setReplay(java.lang.String value) |
void |
setSkip(int value) |
void |
setStats(int value) |
addProgressFeed, checkin, checkout, getArgs, getCmdParent, getContext, getID, getInterrupt, getMessageHandler, getMQ, getMsgID, getName, getPollTime, getState, getVerbose, isStateChanged, processException, processMessage, processMessage, processMessages, processReady, restart, run, runSingle, setArg, setArgs, setCmdParent, setMessageHandler, setMsgID, setPollTime, setProgressFeed, setState, setState, setVerbose, stateToString, thisIsMe, toString, verify, whoIsThis
public static java.lang.String replayList
public static java.lang.String algorithmList
public static java.lang.String syncList
public static java.lang.String throttleList
public static java.lang.String monitorList
public int open()
nxm.sys.inc.Commandable
Commandable.process()
and should be used to open
any files needed and to initialize any parameters.open
in interface nxm.sys.inc.Commandable
open
in class nxm.sys.lib.Command
Commandable.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.Commandable
Commandable.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.Commandable
process
in class nxm.sys.lib.Command
Commandable.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.Commandable
Commandable.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.Commandable
close
in class nxm.sys.lib.Command
Commandable.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 void setMonitor(java.lang.String value)
public void setRate(int value)
public void setFreq(double value)
public void setDec(int value)
public void setGain(int value)
public void setSkip(int value)
public void setStats(int value)
public int getRate()
public double getFreq()
public int getDec()
public int getGain()
public int getSkip()
public int getCycle()
public long getIndex()
public double getProgress()
nxm.sys.lib.Command
getProgress
in class nxm.sys.lib.Command
public java.lang.String getMonitor()
public DevIce.TimeCode getTimeCode()
public nxm.sys.lib.Time getTime()
public int getHBLost()
public int getCBLost()
public int getPFull()
public int getDmaMode()
getDmaMode
in interface PicSlave
public double getOffset()
public MDevIce getDevIce()
public java.lang.String[] getKeys()
nxm.sys.inc.Keyable
getKeys
in interface nxm.sys.inc.Keyable
public java.lang.Object setKey(java.lang.String key, java.lang.Object value)
nxm.sys.inc.Keyable
setKey
in interface nxm.sys.inc.Keyable
key
- 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.Keyable
getKey
in interface nxm.sys.inc.Keyable
key
- The key identifying the value.