sinkpic

java.lang.Object
- nxm.sys.lib.Command
- - nxm.sys.lib.Primitive
  - - nxm.ice.prim.sinkpic

All Implemented Interfaces:

java.lang.Runnable, PicSlave, nxm.sys.inc.Commandable, nxm.sys.inc.Constants, nxm.sys.inc.DataTypes, nxm.sys.inc.IDable, nxm.sys.inc.Keyable, nxm.sys.inc.MessageHandler, nxm.sys.inc.MidasReference
```
public final class sinkpic
extends nxm.sys.lib.Primitive
implements PicSlave, nxm.sys.inc.Keyable
```
Synchronize a PIC playback from a Midas file/pipe.

Author:

Jeff Schoen

Field Summary

Fields
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

Fields inherited from class nxm.sys.lib.Primitive
bufSize, todo

Fields inherited from class nxm.sys.lib.Command
args, flagsList, id, isPiped, M, MA, MQ, MR, MT, name, option, queue, state, support, thread

Fields inherited from interface nxm.sys.inc.DataTypes
ALAW, 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_TABLE

Fields inherited from interface nxm.sys.inc.Constants
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

Fields inherited from interface nxm.sys.inc.Commandable
ABORT, CLOSE, DONE, EXIT, FINISH, INIT, NOOP, NORMAL, OPEN, PAUSE, PROCESS, RESTART, RESUME, SLEEP, START, stateList, stateListOffset, STOP, SUSPEND, WAIT

Constructor Summary

Constructors
Constructor and Description

sinkpic()

Constructors
Constructor and Description
`sinkpic()`

Method Summary

All Methods Instance Methods Concrete Methods
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)`

Methods inherited from class nxm.sys.lib.Primitive
isPipable, todo, todo

Methods inherited from class nxm.sys.lib.Command
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, whoIsThis

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface nxm.sys.inc.DataTypes
createNumberTypes

- Field Detail
  - replayList
```
public static java.lang.String replayList
```
    List of supported replay modes
  - rFILE
```
public static int rFILE
```
  - rSTOPPED
```
public static int rSTOPPED
```
  - rONESHOT
```
public static int rONESHOT
```
  - rCONTINUOUS
```
public static int rCONTINUOUS
```
  - rSTOPTOP
```
public static int rSTOPTOP
```
  - rSTOPNOW
```
public static int rSTOPNOW
```
  - rSPIN
```
public static int rSPIN
```
  - rARCHIVE
```
public static int rARCHIVE
```
  - rRESTART
```
public static int rRESTART
```
  - rABORT
```
public static int rABORT
```
  - rFINISH
```
public static int rFINISH
```
  - rNEWDEVICE
```
public static int rNEWDEVICE
```
  - rREOPEN
```
public static int rREOPEN
```
  - rRECONNECT
```
public static int rRECONNECT
```
  - rRELEASE
```
public static int rRELEASE
```
  - rRESTART_WAIT
```
public static int rRESTART_WAIT
```
  - syncList
```
public static java.lang.String syncList
```
    List of supported master/slave modes
  - throttleList
```
public static java.lang.String throttleList
```
    List of supported throttle modes
  - monitorList
```
public static java.lang.String monitorList
```
    List of supported asynchronous monitor modes
- Constructor Detail
  - sinkpic
```
public sinkpic()
```
- Method Detail
  - open
```
public int open()
```
    Description copied from interface: nxm.sys.inc.Commandable
    
    This will prepare the commandable object for processing. This method must be called prior to calling Commandable.process() and should be used to open any files needed and to initialize any parameters.
    Specified by:
    
    open in interface nxm.sys.inc.Commandable
    
    Overrides:
    
    open in class nxm.sys.lib.Command
    
    Returns:
    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()).
    See Also:
    
    Commandable.process(), Commandable.close(), State Diagram for a Commandable Object
  - process
```
public int process()
```
    Description copied from interface: nxm.sys.inc.Commandable
    
    This will process the commandable objects algorithm. The 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.
    
    If the commandable object requires multiple processing cycles it will return Commandable.NORMAL or Commandable.NOOP.
    Specified by:
    
    process in interface nxm.sys.inc.Commandable
    
    Overrides:
    
    process in class nxm.sys.lib.Command
    
    Returns:
    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.
    See Also:
    
    Time.sleep(double), Commandable.open(), Commandable.close(), State Diagram for a Commandable Object
  - close
```
public int close()
```
    Description copied from interface: nxm.sys.inc.Commandable
    
    This will finish the commandable objects processing. This method is to be used to "clean up" after running 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).
    Specified by:
    
    close in interface nxm.sys.inc.Commandable
    
    Overrides:
    
    close in class nxm.sys.lib.Command
    
    Returns:
    Commandable.NOOP if this method does no work.
    
    Commandable.NORMAL if this method successfully completes.
    See Also:
    
    Results, Commandable.open(), Commandable.process(), State Diagram for a Commandable Object
  - setReplay
```
public void setReplay(java.lang.String value)
```
    Description copied from interface: PicSlave
    
    Sets the replay mode of the slave device
    
    Specified by:
    
    setReplay in interface PicSlave
  - setMonitor
```
public void setMonitor(java.lang.String value)
```
  - setChan
```
public void setChan(int chan)
```
  - setRate
```
public void setRate(int value)
```
  - setFreq
```
public void setFreq(double value)
```
  - setDec
```
public void setDec(int value)
```
  - setGain
```
public void setGain(int value)
```
  - setSkip
```
public void setSkip(int value)
```
  - setStats
```
public void setStats(int value)
```
  - setSFName
```
public java.lang.String setSFName(java.lang.String value)
```
  - setArchTop
```
public void setArchTop(double top)
```
  - setArchDur
```
public void setArchDur(double dur)
```
  - getReplay
```
public java.lang.String getReplay()
```
    Description copied from interface: PicSlave
    
    Gets the replay mode of the slave device
    
    Specified by:
    
    getReplay in interface PicSlave
    
    Returns:
    
    replay mode
  - getRate
```
public int getRate()
```
  - getFreq
```
public double getFreq()
```
  - getDec
```
public int getDec()
```
  - getGain
```
public int getGain()
```
  - getSkip
```
public int getSkip()
```
  - getCycle
```
public int getCycle()
```
  - getIndex
```
public long getIndex()
```
  - getProgress
```
public double getProgress()
```
    Description copied from class: nxm.sys.lib.Command
    
    returns the 0.0 -> 1.0 progress based on input file.
    
    Overrides:
    
    getProgress in class nxm.sys.lib.Command
    
    Returns:
    
    a double value between 0 and 1 indicating the current progress, or -2 if an error has occurred.
  - getMonitor
```
public java.lang.String getMonitor()
```
  - getThrottle
```
public java.lang.String getThrottle()
```
  - getTimeCode
```
public DevIce.TimeCode getTimeCode()
```
  - getTime
```
public nxm.sys.lib.Time getTime()
```
  - getHBLost
```
public int getHBLost()
```
  - getCBLost
```
public int getCBLost()
```
  - getPFull
```
public int getPFull()
```
  - getASFN
```
public ArchSFN getASFN()
```
  - getArchiver
```
public ArchSFN getArchiver()
```
  - getArchDur
```
public double getArchDur()
```
  - getArchOff
```
public double getArchOff()
```
  - getArchTop
```
public double getArchTop()
```
  - getSFName
```
public java.lang.String getSFName()
```
  - getDmaMode
```
public int getDmaMode()
```
    Description copied from interface: PicSlave
    
    Gets the current DMA mode slave device
    
    Specified by:
    
    getDmaMode in interface PicSlave
    
    Returns:
    
    DMA mode
  - getOffset
```
public double getOffset()
```
  - getDelta
```
public double getDelta()
```
  - getDevIce
```
public MDevIce getDevIce()
```
  - getMBPS
```
public float getMBPS()
```
  - getArchFN
```
public java.lang.String getArchFN()
```
  - getTable
```
public nxm.sys.lib.Table getTable(nxm.sys.lib.Table t)
```
  - getKeys
```
public java.lang.String[] getKeys()
```
    Description copied from interface: nxm.sys.inc.Keyable
    
    Get a list of the available keys.
    
    Specified by:
    
    getKeys in interface nxm.sys.inc.Keyable
    
    Returns:
    
    An array of Strings holding the key names.
  - setKey
```
public java.lang.Object setKey(java.lang.String key,
                               java.lang.Object value)
```
    Description copied from interface: nxm.sys.inc.Keyable
    
    Set the value of an object's keyed field.
    
    Specified by:
    
    setKey in interface nxm.sys.inc.Keyable
    
    Parameters:
    
    key - The key identifying the value.
    
    value - The new value to associate with the key.
    
    Returns:
    
    The specified value (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.
  - getKey
```
public java.lang.Object getKey(java.lang.String key)
```
    Description copied from interface: nxm.sys.inc.Keyable
    
    Get the value of an object's keyed field.
    
    Specified by:
    
    getKey in interface nxm.sys.inc.Keyable
    
    Parameters:
    
    key - The key identifying the value.
    
    Returns:
    
    The value associated with the key.

Class sinkpic

Field Summary

Fields inherited from class nxm.sys.lib.Primitive

Fields inherited from class nxm.sys.lib.Command

Fields inherited from interface nxm.sys.inc.DataTypes

Fields inherited from interface nxm.sys.inc.Constants

Fields inherited from interface nxm.sys.inc.Commandable

Constructor Summary

Method Summary

Methods inherited from class nxm.sys.lib.Primitive

Methods inherited from class nxm.sys.lib.Command

Methods inherited from class java.lang.Object

Methods inherited from interface nxm.sys.inc.DataTypes

Field Detail

replayList

rFILE

rSTOPPED

rONESHOT

rCONTINUOUS

rSTOPTOP

rSTOPNOW

rSPIN

rARCHIVE

rRESTART

rABORT

rFINISH

rNEWDEVICE

rREOPEN

rRECONNECT

rRELEASE

rRESTART_WAIT

syncList

throttleList

monitorList

Constructor Detail

sinkpic

Method Detail

open

process

close

setReplay

setMonitor

setChan

setRate

setFreq

setDec

setGain

setSkip

setStats

setSFName

setArchTop

setArchDur

getReplay

getRate

getFreq

getDec

getGain

getSkip

getCycle

getIndex

getProgress

getMonitor

getThrottle

getTimeCode

getTime

getHBLost

getCBLost

getPFull

getASFN

getArchiver

getArchDur

getArchOff

getArchTop

getSFName

getDmaMode

getOffset

getDelta

getDevIce

getMBPS

getArchFN