sourcepic

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

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 sourcepic
extends nxm.sys.lib.Primitive
implements PicSlave, nxm.sys.inc.Keyable
```
Synchronize a PIC acquisition into a Midas file/pipe. If /MULTI=n is used, this primitive controls multiple ports at once.

Author:

Jeff Schoen

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`archList` List of supported archive modes
`static java.lang.String`	`monitorList` List of supported asynchronous monitor modes
`static java.lang.String`	`pktmodeList` List of supported packet 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

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

sourcepic()

Constructors
Constructor and Description
`sourcepic()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`close()` This will finish the commandable objects processing.
`ICEPacket`	`getAPkt()`
`double`	`getArchDur()`
`java.lang.String`	`getArchFN()`
`Archiver`	`getArchiver()`
`nxm.sys.lib.Table`	`getArchKW()`
`java.lang.String`	`getArchMode()`
`double`	`getArchOff()`
`double`	`getArchTop()`
`double`	`getBytes()`
`double`	`getBytesOut()`
`int`	`getCBLost()`
`int`	`getChannel()`
`double`	`getChannelFreq(int chn)`
`int`	`getChnGain(int chan)`
`int`	`getCycle()`
`int`	`getDec()`
`double`	`getDelta()`
`MDevIce`	`getDevIce()`
`int`	`getDmaMode()` Gets the current DMA mode slave device
`java.lang.String`	`getFormat()`
`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()`
`ICEPacket`	`getPkt()`
`java.lang.String`	`getPort()`
`double`	`getProgress()` returns the `0.0 -> 1.0` progress based on input file.
`int`	`getRate()`
`double`	`getRatio()`
`java.lang.String`	`getReplay()` Gets the replay mode of the slave device
`double`	`getRfFreq()`
`int`	`getRfGain()`
`int`	`getSkip()`
`double`	`getSyncOff()`
`nxm.sys.lib.Table`	`getTable(nxm.sys.lib.Table t)`
`int`	`getTCMode()`
`nxm.sys.lib.Time`	`getTime()`
`DevIce.TimeCode`	`getTimeCode()`
`boolean`	`isTuner()`
`int`	`open()` This will prepare the commandable object for processing.
`int`	`process()` This will process the commandable objects algorithm.
`void`	`setAGC(nxm.sys.lib.Table tbl)`
`void`	`setAgcLevel(double value)`
`void`	`setAgcWidth(double value)`
`void`	`setArchDur(double value)`
`void`	`setArchFN(java.lang.String value)`
`void`	`setArchMode(java.lang.String value)`
`void`	`setArchOff(double value)`
`void`	`setChannel(int value)`
`void`	`setDec(int value)`
`void`	`setEnable(int value)`
`void`	`setFreq(double value)`
`void`	`setFreqs(nxm.sys.lib.Data value)`
`void`	`setGain(int value)`
`void`	`setGPW(nxm.sys.libg.GValue value)`
`java.lang.Object`	`setKey(java.lang.String key, java.lang.Object value)` Set the value of an object's keyed field.
`void`	`setMaxGain(int value)`
`void`	`setMinGain(int value)`
`void`	`setMonitor(java.lang.String value)`
`void`	`setRate(int value)`
`void`	`setRatio(double value)`
`void`	`setReplay(java.lang.String value)` Sets the replay mode of the slave device
`void`	`setRfFreq(double value)`
`void`	`setRfFreqKWO(double value)`
`void`	`setRfGain(int value)`
`void`	`setSelect(int value)`
`void`	`setStats(int value)`
`void`	`setSyncOff(double value)`
`static void`	`setTime(nxm.sys.lib.DataFile df, double wsec, double fsec)`
`void`	`startArchiver()`
`void`	`startArchiver(java.lang.String fname)`
`void`	`startArchiver(java.lang.String fname, double dur)`
`void`	`startArchiver(java.lang.String fname, double off, double dur)`
`void`	`stopArchiver()`

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
  - archList
```
public static java.lang.String archList
```
    List of supported archive modes
  - pktmodeList
```
public static java.lang.String pktmodeList
```
    List of supported packet modes
  - monitorList
```
public static java.lang.String monitorList
```
    List of supported asynchronous monitor modes
- Constructor Detail
  - sourcepic
```
public sourcepic()
```
- 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
  - setArchFN
```
public void setArchFN(java.lang.String value)
```
  - setArchDur
```
public void setArchDur(double value)
```
  - setArchOff
```
public void setArchOff(double value)
```
  - setSyncOff
```
public void setSyncOff(double value)
```
  - setArchMode
```
public void setArchMode(java.lang.String value)
```
  - startArchiver
```
public void startArchiver(java.lang.String fname)
```
  - startArchiver
```
public void startArchiver(java.lang.String fname,
                          double dur)
```
  - startArchiver
```
public void startArchiver(java.lang.String fname,
                          double off,
                          double dur)
```
  - startArchiver
```
public void startArchiver()
```
  - stopArchiver
```
public void stopArchiver()
```
  - 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
  - setRate
```
public void setRate(int value)
```
  - setFreq
```
public void setFreq(double value)
```
  - setFreqs
```
public void setFreqs(nxm.sys.lib.Data value)
```
  - setDec
```
public void setDec(int value)
```
  - setGain
```
public void setGain(int value)
```
  - setRatio
```
public void setRatio(double value)
```
  - setSelect
```
public void setSelect(int value)
```
  - setChannel
```
public void setChannel(int value)
```
  - setEnable
```
public void setEnable(int value)
```
  - setMonitor
```
public void setMonitor(java.lang.String value)
```
  - setStats
```
public void setStats(int value)
```
  - setMinGain
```
public void setMinGain(int value)
```
  - setMaxGain
```
public void setMaxGain(int value)
```
  - setAgcLevel
```
public void setAgcLevel(double value)
```
  - setAgcWidth
```
public void setAgcWidth(double value)
```
  - setGPW
```
public void setGPW(nxm.sys.libg.GValue value)
```
  - 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
  - getDec
```
public int getDec()
```
  - getGain
```
public int getGain()
```
  - getRate
```
public int getRate()
```
  - getRatio
```
public double getRatio()
```
  - getFreq
```
public double getFreq()
```
  - getPort
```
public java.lang.String getPort()
```
  - getRfGain
```
public int getRfGain()
```
  - getRfFreq
```
public double getRfFreq()
```
  - getChannel
```
public int getChannel()
```
  - 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.
  - getBytes
```
public double getBytes()
```
  - getBytesOut
```
public double getBytesOut()
```
  - getSkip
```
public int getSkip()
```
  - getMonitor
```
public java.lang.String getMonitor()
```
  - getTime
```
public nxm.sys.lib.Time getTime()
```
  - getTimeCode
```
public DevIce.TimeCode getTimeCode()
```
  - getFormat
```
public java.lang.String getFormat()
```
  - getHBLost
```
public int getHBLost()
```
  - getPFull
```
public int getPFull()
```
  - getCBLost
```
public int getCBLost()
```
  - 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()
```
  - getDevIce
```
public MDevIce getDevIce()
```
  - getArchiver
```
public Archiver getArchiver()
```
  - getArchFN
```
public java.lang.String getArchFN()
```
  - getArchMode
```
public java.lang.String getArchMode()
```
  - getArchDur
```
public double getArchDur()
```
  - getArchOff
```
public double getArchOff()
```
  - getArchTop
```
public double getArchTop()
```
  - getArchKW
```
public nxm.sys.lib.Table getArchKW()
```
  - getSyncOff
```
public double getSyncOff()
```
  - getPkt
```
public ICEPacket getPkt()
```
  - getAPkt
```
public ICEPacket getAPkt()
```
  - getMBPS
```
public float getMBPS()
```
  - getTCMode
```
public int getTCMode()
```
  - isTuner
```
public boolean isTuner()
```
  - getDelta
```
public double getDelta()
```
  - getChannelFreq
```
public double getChannelFreq(int chn)
```
  - setAGC
```
public void setAGC(nxm.sys.lib.Table tbl)
```
  - setRfGain
```
public void setRfGain(int value)
```
  - setRfFreqKWO
```
public void setRfFreqKWO(double value)
```
  - setRfFreq
```
public void setRfFreq(double value)
```
  - 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.
  - getChnGain
```
public int getChnGain(int chan)
```
  - setTime
```
public static void setTime(nxm.sys.lib.DataFile df,
                           double wsec,
                           double fsec)
```

Class sourcepic

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

archList

pktmodeList

monitorList

Constructor Detail

sourcepic

Method Detail

open

process

close

setArchFN

setArchDur

setArchOff

setSyncOff

setArchMode

startArchiver

startArchiver

startArchiver

startArchiver

stopArchiver

setReplay

setRate

setFreq

setFreqs

setDec

setGain

setRatio

setSelect

setChannel

setEnable

setMonitor

setStats

setMinGain

setMaxGain

setAgcLevel

setAgcWidth

setGPW

getReplay

getDec

getGain

getRate

getRatio

getFreq

getPort

getRfGain

getRfFreq

getChannel

getCycle

getIndex