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 |
monitorList
List of supported asynchronous monitor modes
|
static int |
rABORT |
static int |
rARCHIVE |
static int |
rCONTINUOUS |
static java.lang.String |
replayList
List of supported replay modes
|
static int |
rFILE |
static int |
rFINISH |
static int |
rNEWDEVICE |
static int |
rONESHOT |
static int |
rRECONNECT |
static int |
rRELEASE |
static int |
rREOPEN |
static int |
rRESTART |
static int |
rRESTART_WAIT |
static int |
rSPIN |
static int |
rSTOPNOW |
static int |
rSTOPPED |
static int |
rSTOPTOP |
static java.lang.String |
syncList
List of supported master/slave modes
|
static java.lang.String |
throttleList
List of supported throttle modes
|
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 |
|---|
sinkpic() |
| Modifier and Type | Method and Description |
|---|---|
int |
close()
This will finish the commandable objects processing.
|
double |
getArchDur() |
java.lang.String |
getArchFN() |
ArchSFN |
getArchiver() |
double |
getArchOff() |
double |
getArchTop() |
ArchSFN |
getASFN() |
int |
getCBLost() |
int |
getCycle() |
int |
getDec() |
double |
getDelta() |
MDevIce |
getDevIce() |
int |
getDmaMode()
Gets the current DMA mode slave device
|
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.
|
float |
getMBPS() |
java.lang.String |
getMonitor() |
double |
getOffset() |
int |
getPFull() |
double |
getProgress()
returns the
0.0 -> 1.0 progress based on input file. |
int |
getRate() |
java.lang.String |
getReplay()
Gets the replay mode of the slave device
|
java.lang.String |
getSFName() |
int |
getSkip() |
nxm.sys.lib.Table |
getTable(nxm.sys.lib.Table t) |
java.lang.String |
getThrottle() |
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 |
setArchDur(double dur) |
void |
setArchTop(double top) |
void |
setChan(int chan) |
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)
Sets the replay mode of the slave device
|
java.lang.String |
setSFName(java.lang.String value) |
void |
setSkip(int value) |
void |
setStats(int value) |
addProgressFeed, checkin, checkout, finishing, getArgs, getCmdParent, getContext, getID, getInterrupt, getMenuCommands, getMessageHandler, getMidas, getMQ, getMsgID, getName, getPollTime, 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 int rFINISH
public static int rNEWDEVICE
public static int rREOPEN
public static int rRECONNECT
public static int rRELEASE
public static int rRESTART_WAIT
public static java.lang.String syncList
public static java.lang.String throttleList
public static java.lang.String monitorList
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)
PicSlavepublic void setMonitor(java.lang.String value)
public void setChan(int chan)
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 java.lang.String setSFName(java.lang.String value)
public void setArchTop(double top)
public void setArchDur(double dur)
public java.lang.String getReplay()
PicSlavepublic 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.Command0.0 -> 1.0 progress based on input file.getProgress in class nxm.sys.lib.Commandpublic java.lang.String getMonitor()
public java.lang.String getThrottle()
public DevIce.TimeCode getTimeCode()
public nxm.sys.lib.Time getTime()
public int getHBLost()
public int getCBLost()
public int getPFull()
public ArchSFN getASFN()
public ArchSFN getArchiver()
public double getArchDur()
public double getArchOff()
public double getArchTop()
public java.lang.String getSFName()
public int getDmaMode()
PicSlavegetDmaMode in interface PicSlavepublic double getOffset()
public double getDelta()
public MDevIce getDevIce()
public float getMBPS()
public java.lang.String getArchFN()
public nxm.sys.lib.Table getTable(nxm.sys.lib.Table t)
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.