icecore

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

All Implemented Interfaces:

java.lang.Runnable, nxm.sys.inc.Chainable, 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 class icecore
extends nxm.sys.lib.Primitive
implements nxm.sys.inc.Chainable, nxm.sys.inc.Keyable, nxm.sys.inc.DataTypes
```
Implements a generic CORE library function

Author:

Jeff Schoen

Field Summary
- Fields inherited from class nxm.sys.lib.Primitive
  bufSize, todo, xfer
- 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

icecore()

Constructors
Constructor and Description
`icecore()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`close()` This will finish the commandable objects processing.
`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.Object`	`getNextLink()` Get the next object down the chain.
`java.lang.Object`	`getPrevLink()` Get the next object up the chain.
`double`	`getProgress()` returns the `0.0 -> 1.0` progress based on input file.
`int`	`open()` This will prepare the commandable object for processing.
`int`	`process()` This will process the commandable objects algorithm.
`java.lang.Object`	`setKey(java.lang.String key, java.lang.Object value)` Set the value of an object's keyed field.

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

- Constructor Detail
  - icecore
```
public icecore()
```
- 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
  - 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.
  - getNextLink
```
public java.lang.Object getNextLink()
```
    Description copied from interface: nxm.sys.inc.Chainable
    
    Get the next object down the chain.
    
    Specified by:
    
    getNextLink in interface nxm.sys.inc.Chainable
    
    Returns:
    
    The next object down the chain.
    
    See Also:
    
    Chainable.getPrevLink()
  - getPrevLink
```
public java.lang.Object getPrevLink()
```
    Description copied from interface: nxm.sys.inc.Chainable
    
    Get the next object up the chain.
    
    Specified by:
    
    getPrevLink in interface nxm.sys.inc.Chainable
    
    Returns:
    
    The next object up the chain.
    
    See Also:
    
    Chainable.getNextLink()
  - 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 icecore

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

Constructor Detail

icecore

Method Detail

open

process

close

getProgress

getNextLink

getPrevLink

getKeys

setKey

getKey