nxm.ice.lib
Class Archiver

java.lang.Object
  nxm.sys.lib.BaseFile
      nxm.sys.lib.DataFile
          nxm.ice.lib.Archiver

All Implemented Interfaces:

nxm.sys.inc.AsciiMap, nxm.sys.inc.DataTypes, nxm.sys.inc.PlotFile

public class Archiver

extends nxm.sys.lib.DataFile

Extends DataFile to handle ICE Archiver functions. Although it acts as one file to the caller, it may split the data stream into multiple output files if setMulti() or setFunction() are non-zero. A TableOfContents is created with the name _toc. Individual channel files are _N where N is the SUFF field of the TOC entry.

Author:

Jeff Schoen

Nested Class Summary

class

Archiver.Channel

Field Summary

static java.lang.String	functionList
static int	ICEBUFSZ
static int	ICEUNPACK
static int	NORMAL
static java.lang.String	propertyList
static int	SDDSBUFSZ
static int	SDDSUNPACK

Fields inherited from class nxm.sys.lib.DataFile

ape, bpa, bps, buffer, consLength, dataMode, dataType, dbpe, defPipeSize, E_DET_FAIL, E_DET_OK, E_HCB_FAIL, E_HCB_OK, E_PKT_FAIL, E_PKT_OK, E_PROT_FAIL, formats, hb, hp, IDELTA, IEND, ioh, ISTART, JDELTA, JEND, JSTART, keywords, next, OFF_ADJUNCT, pkh, Q_ALT, Q_AZIM, Q_ELEV, Q_GHA, Q_LAT, Q_LON, Q_RF, Q_ROLL, Q_SEC, Q_YEAR, RDELTA, spa, timeLine, typeClass, types, xferLength

Fields inherited from class nxm.sys.lib.BaseFile

APPEND, aux, BASE, cmd, comment, DATA, DBF, EQ_BIN, EQ_DATA, EQ_DEF, EQ_HDR, EQ_KEY, EQ_SIZE, filename, flags, flagsList, FLUSH, fn, IMAGE, INOUT, INPUT, io, isFound, isInput, isOpen, isOutput, JAR, M, MKDIR, NATIVE, NOABORT, NOOPEN, OPTIONAL, OUTPUT, PKTHDR, RADIX_1, RADIX_10, RADIX_16, RADIX_2, RADIX_8, SHAPE, size, tag, TAR, TEXT, WRAP, ZIP

Fields inherited from interface nxm.sys.inc.AsciiMap

BANG, BSLASH, BTIC, CARET, COLON, COMMA, CR, EQUALS, FTIC, HTAB, LBRACE, LCURLY, LF, LOWER2UPPER, LOWERA, LOWERZ, LPAREN, MINUS, NINE, NULL, PERIOD, PLUS, QUOTE, RBRACE, RCURLY, RPAREN, SCOLON, SLASH, SPACE, TILDE, UPPER2LOWER, UPPERA, UPPERZ, ZERO

Fields inherited from interface nxm.sys.inc.DataTypes

ALAW, ASCII, BMAX, BMIN, BOOL, BYTE, COMPLEX, CONVERT_TYPE_LIST, CRAY, DATA_TYPE_LIST, DMAX, DMIN, DOUBLE, EEEI, FLOAT, FMAX, FMIN, IEEE, IMAX, IMIN, INT, LMAX, LMIN, LONG, MATRIX, NONHOMOGENEOUS, NUMBER, OBJECT, PACKED, QUAD, RESULT_TYPE_LIST, SCALAR, STRING, TABLE, TRANSMATRIX, ULAW, VAX, VECTOR, XLONG, XMAX, XMIN, XMODE

Constructor Summary

Archiver(sourcepic sp)

Method Summary

void	checkChannels()
void	close()
int	findSDDSChannel(long lbuf, int boff, int bytes)
void	flush()
Archiver.Channel	getChannel()
Archiver.Channel	getChannel(int i)
nxm.sys.lib.KeyVector	getChannels()
java.lang.String	getFunction()
int	getMaxLines()
double	getMaxLineSize()
int	getMulti()
boolean	open()
void	setAAux(java.lang.String aux)
void	setAAux1(java.lang.String aux)
void	setAAux2(java.lang.String aux)
void	setFunction(java.lang.String function)
void	setMaxLines(int lines)
void	setMaxLineSize(double bytes)
void	setMulti(int channels)
int	write(long lbuf, int boff, int bytes, int chan)

Methods inherited from class nxm.sys.lib.DataFile

addComp, addComp, addSubRec, addSubRec, align, avail, checkFormat, checkType, compare, connect, convertHeaderRep, convertHeaderRep, convertRecordRep, copyHeader, equals, equals, equals, equalsHeader, equalsKeywordsExt, erase, find, findRec, findRecOffset, getAPE, getBPA, getBPE, getBPS, getCircularFileOffset, getCompFormat, getCompName, getCompOffset, getCompType, getCompUnits, getConsLength, getCreator, getData, getData, getDataBuffer, getDataBuffer, getDataMask, getDataRep, getDataSize, getDataStart, getDataStop, getDataT, getDataTable, getDelta, getDetached, getDetachName, getExtended, getExtSize, getExtStart, getFM, getFMT, getFormat, getFormatMode, getFormatType, getFrameSize, getFS, getHeadRep, getInByte, getIndex, getIndex, getIndex, getIndex, getIndex, getIndexAt, getInlet, getKeyLength, getKeyScope, getKeywords, getLayer, getLength, getMode, getNumberComponents, getNumberSubRecords, getNyquist, getOutByte, getOutlets, getOutMask, getPacket, getPacketHandler, getPacketHandlerFlags, getPipe, getPipeId, getPipeLoc, getPipeSize, getProtected, getQuadword, getQW, getRecFormat, getRecFormatMode, getRecFormatType, getRecLength, getRecName, getRecOffset, getRecord, getReferenceFrame, getREP, getSize, getSPA, getStart, getSubsize, getSubSize, getTime, getTimeAt, getTimeAt, getTimeCode, getTimeLineHandler, getTransLength, getTY, getType, getUniqueRecName, getUniqueRecName, getUnits, getURL, getVersion, getXDelta, getXferLength, getXFrame, getXStart, getXUnits, getYDelta, getYFrame, getYStart, getYUnits, hb2p, init, init, init, init, init, initMain, isFile, isPipe, listElements, listElementsPerLine, listHeader, listKeywords, p2hb, read, read, read, read, read, read, rename, reOpen, seek, seek, setC, setCircularFileLength, setComment, setComp, setCompFormat, setCompName, setComponents, setCompType, setCompUnits, setConsLength, setCreator, setCreator, setCTG, setData, setData, setData, setData, setDataMask, setDataRep, setDataSize, setDataStart, setDelta, setDetached, setDFS, setExtSize, setExtStart, setFM, setFMT, setFormat, setFormat, setFormatMode, setFormatType, setFrame, setFrameSize, setFS, setHeadRep, setInByte, setInlet, setInternals, setKeyLength, setKeyScope, setKeywords, setNumberComponents, setNumberSubRecords, setOutByte, setOutlets, setOutMask, setPacket, setPacketHandler, setPipeId, setPipeLoc, setPipeSize, setProtected, setQuadword, setQW, setRC, setRecFormat, setRecLength, setRecName, setRecOffset, setReferenceFrame, setREP, setSize, setSize, setSR, setStart, setSubRec, setSubRecords, setSubsize, setSubSize, setTC, setTime, setTime, setTimeAt, setTimeAt, setTimeCode, setTransLength, setTY, setType, setType, setUnits, setVersion, setXDelta, setXferLength, setXStart, setXUnits, setYDelta, setYStart, setYUnits, skip, testRep, toString, update, write, write, write, write, write, write, write

Methods inherited from class nxm.sys.lib.BaseFile

compare, copy, delete, equalsBF, getAux, getCO, getComment, getFileNameFor, getInstanceFor, getOffset, getQualifier, getQualifiers, getResource, getSZ, getTag, isOpen, isStream, isStreaming, open, parseFileTestFlag, readByte, setAux, setAux, setCO, setExt, setExtDefault, setFlags, setFlags, setName, setOutput, setQualifier, setSZ, setTag, status

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface nxm.sys.inc.PlotFile

getQualifier, getTag, isOpen, isStream, isStreaming, open

Field Detail

propertyList

public static final java.lang.String propertyList

See Also:

Constant Field Values

functionList

public static final java.lang.String functionList

See Also:

Constant Field Values

NORMAL

public static final int NORMAL

See Also:

Constant Field Values

ICEUNPACK

public static final int ICEUNPACK

See Also:

Constant Field Values

SDDSUNPACK

public static final int SDDSUNPACK

See Also:

Constant Field Values

SDDSBUFSZ

public static final int SDDSBUFSZ

See Also:

Constant Field Values

ICEBUFSZ

public static final int ICEBUFSZ

See Also:

Constant Field Values

Constructor Detail

Archiver

public Archiver(sourcepic sp)

Method Detail

getMulti

public int getMulti()

getFunction

public java.lang.String getFunction()

getMaxLines

public int getMaxLines()

getMaxLineSize

public double getMaxLineSize()

setMulti

public void setMulti(int channels)

setFunction

public void setFunction(java.lang.String function)

setMaxLines

public void setMaxLines(int lines)

setMaxLineSize

public void setMaxLineSize(double bytes)

open

public boolean open()

flush

public void flush()

close

public void close()

write

public int write(long lbuf,
                 int boff,
                 int bytes,
                 int chan)

setAAux

public void setAAux(java.lang.String aux)

setAAux1

public void setAAux1(java.lang.String aux)

setAAux2

public void setAAux2(java.lang.String aux)

getChannel

public Archiver.Channel getChannel()

getChannel

public Archiver.Channel getChannel(int i)

getChannels

public nxm.sys.lib.KeyVector getChannels()

findSDDSChannel

public int findSDDSChannel(long lbuf,
                           int boff,
                           int bytes)

checkChannels

public void checkChannels()