Archiver

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Cloneable, nxm.sys.inc.AsciiMap, nxm.sys.inc.DataTypes, nxm.sys.inc.ListFile
```
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 setFunc() are non-zero. A TableOfContents is created with the name [archive]_toc. A PSD is created with the name [archive]_psd. Individual channel files are [archive]_N where N is the KEY field of the TOC entry. Special qualifiers apply to files accessed by this class: FUNC=s Function supports MULTI MULTI=n Multiple file mode THROTTLE=r Throttle to max Mby/sec MAXLEN=n Stop at this maximum file length NFFT=n FFT size for PSD auxiliary file PSDR=n Output PSD frame at n frames per second NAVG=n FFTs to average for each output frame NCPA=n Number of channels per address for network streams TOP=t Time of interest in a multifile archive DUR=r Duration of interest in a multifile archive EVENT=s Event name of interest in a multifile archive GPS=s Filename with updating GPS data RG=IFS Resource group IceFileSystem for direct IO from mapped buffers

Author:

Jeff Schoen

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Archiver.Channel

class Archiver.PSD

static class Archiver.ToC

static class Archiver.ToCR

Nested Classes
Modifier and Type	Class and Description
`class`	`Archiver.Channel`
`class`	`Archiver.PSD`
`static class`	`Archiver.ToC`
`static class`	`Archiver.ToCR`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`functionList` Packet modes list
`static int`	`ICEBUFSZ` Other constnts
`static int`	`ICEDEMUX` Packet types
`static int`	`ICEMULTI` Packet types
`static int`	`ICEUNPACK` Packet types
`static int`	`MAXNIOBUF` Other constnts
`static int`	`NIO` Packet modes
`static int`	`NORMAL` Packet types
`static java.lang.String`	`propertyList` Packet types list
`static int`	`RAWMULTI` Packet types
`static int`	`RAWMULTISZ` Other constnts
`static int`	`SDDSBUFSZ` Other constnts
`static int`	`SDDSMULTI` Packet types
`static int`	`SDDSUNPACK` Packet types
`static int`	`VRTMULTI` Packet types

Fields inherited from class nxm.sys.lib.DataFile
ADDR_ABSCISSA, ADDR_ABSCISSA_AUTO, ADDR_ABSCISSA_LEGACY, ADDR_INDEX, ADDR_TIMECODE, ADDR_UNKNOWN, addressingModeList, ADJUNCT_COMP_OFF, ADJUNCT_COMPONENTS_OFF, ADJUNCT_NRECORD_OFF, ADJUNCT_QUADWORD_OFF, ADJUNCT_R2DELTA_OFF, ADJUNCT_R2START_OFF, ADJUNCT_R2UNITS_OFF, ADJUNCT_RDELTA_OFF, ADJUNCT_RECLGTH_OFF, ADJUNCT_RSTART_OFF, ADJUNCT_RUNITS_OFF, ADJUNCT_SUBREC_OFF, ADJUNCT_SUBRSTR_OFF, ADJUNCT_SUBSIZE_OFF, ADJUNCT_T2DELTA_OFF, ADJUNCT_T2START_OFF, ADJUNCT_T2UNITS_OFF, ADJUNCT_TDELTA_OFF, ADJUNCT_TSTART_OFF, ADJUNCT_TUNITS_OFF, ADJUNCT_VR2DELTA_OFF, ADJUNCT_VR2START_OFF, ADJUNCT_VR2UNITS_OFF, ADJUNCT_VRDELTA_OFF, ADJUNCT_VRSTART_OFF, ADJUNCT_VRUNITS_OFF, ADJUNCT_XDELTA_OFF, ADJUNCT_XSTART_OFF, ADJUNCT_XUNITS_OFF, ADJUNCT_YDELTA_OFF, ADJUNCT_YSTART_OFF, ADJUNCT_YUNITS_OFF, ape, BLUE_FILE_READ_ERROR, bpa, bps, BYTE_BLOCK_SIZE, CHARS_FORMAT, CHARS_REP, CHARS_VERSION, 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, enableNewRestartCode, formats, hb, HEADER_SIZE, hp, IDELTA, IEND, IFROMSIZE, IMODEDEF, ioh, IRELATIVE, ISTART, ITILDE, JDELTA, JEND, JSTART, keywords, OFF_ADJUNCT, OFF_DATAREP, OFF_DATASIZE, OFF_DATASTART, OFF_DETACHED, OFF_EXTSIZE, OFF_EXTSTART, OFF_FLAGMASK, OFF_FORMAT, OFF_HEADREP, OFF_INBYTE, OFF_INLET, OFF_KEYLGTH, OFF_KEYWORDS, OFF_OUTBYTE, OFF_OUTBYTES, OFF_OUTLETS, OFF_OUTMASK, OFF_PIPE, OFF_PIPELOC, OFF_PIPESIZE, OFF_PROTECTED, OFF_TIMECODE, OFF_TYPE, OFF_VERSION, pkh, PM_DEFAULT, PM_HEADER, PM_KEYWORDS, PM_KEYWORDSEXT, PM_KEYWORDSMAIN, PM_PACKETHANDLER, PM_TIMECODE, propagationMaskList, Q_ALT, Q_AZIM, Q_ELEV, Q_GHA, Q_LAT, Q_LON, Q_RF, Q_ROLL, Q_SEC, Q_YEAR, QUALIFIER_PLATINUM_TIMELINE, QUALIFIER_TC_TIMELINE, QUALIFIER_USEC_TIMELINE, RDELTA, spa, timeLine, typeClass, types, xferLength

Fields inherited from class nxm.sys.lib.BaseFile
ALWAYSREOPEN, APPEND, aux, BASE, BUFFER_SIZE, cmd, comment, DATA, DBF, DEF_FLAGS, DONOTADDEXTENSION, EMBEDDEDLF, EQ_BIN, EQ_DATA, EQ_DEF, EQ_HDR, EQ_KEY, EQ_LENLIM, EQ_SIZE, EQ_TOL, filename, flags, flagsList, FLUSH, fn, FORCEABORT, hasLinefeed, HEADERONLY, IMAGE, INOUT, INPUT, io, isFound, isInput, isOpen, isOutput, JAR, M, MAINTAINCASE, MKDIR, NATIVE, NOABORT, NOOPEN, OPTIONAL, OUTPUT, PKTHDR, RADIX_10, RADIX_16, RADIX_2, RADIX_8, REOPEN, SHAPE, size, tag, TAR, TEXT, tolerance, TRUNCATE, WAIT, WARNEMPTY, WRAP, ZIP

Fields inherited from interface nxm.sys.inc.PlotFile
T_CONT, T_DOT, T_LINE, T_MESH, T_POINT, T_RASTER, typeList

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, 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

Constructor Summary

Constructors
Constructor and Description

Archiver()
Extensions to DataFile for archiving

Archiver(sourcepic sp)
Extensions to DataFile for archiving

Constructors
Constructor and Description
`Archiver()` Extensions to DataFile for archiving
`Archiver(sourcepic sp)` Extensions to DataFile for archiving

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addEventKey(java.lang.String key, double value)`
`void`	`checkChannels()`
`void`	`close()` Close a data connection.
`void`	`discontinue()`
`static int`	`doFunc(java.lang.Object ref, java.lang.String func, java.lang.String fname, double ttop, double tdur, java.lang.String event, java.lang.String file)`
`int`	`findDemuxChannel(long lbuf, int boff, int bytes)`
`int`	`findSDDSChannel(long lbuf, int boff, int bytes)`
`void`	`flush()` Flush any cached data to disk and update header.
`Archiver.Channel`	`getChannel()`
`Archiver.Channel`	`getChannel(int i)`
`java.lang.String`	`getChannelFormat()`
`double`	`getChannelFreq()`
`nxm.sys.lib.KeyVector`	`getChannels()`
`nxm.sys.lib.Time`	`getChannelTime()`
`java.lang.String`	`getEvent()`
`long`	`getExportSize()`
`static java.lang.String`	`getFileAt(java.lang.Object ref, java.lang.String fname, double ttop, double tdur, int xfer)`
`java.lang.String`	`getFunc()`
`default nxm.sys.libg.Layer`	`getLayer()` Get the default `Layer` on which this file is plotted.
`default nxm.sys.libg.Layer`	`getLayer(int plotType)` Deprecated. Removing libg dependencies from lib due to JDK 11+ Modularity. Since NeXtMidas 3.9.1
`double`	`getLength()` get length of file
`double`	`getLengthBytes()`
`int`	`getMaxLines()`
`double`	`getMaxLineSize()`
`int`	`getMulti()`
`nxm.sys.lib.FileName`	`getName()` Get the file name for the file, with any qualifiers and trimmers.
`nxm.sys.lib.FileName`	`getName()` Get the file name for the file, with any qualifiers and trimmers.
`double`	`getOffset()` Get the current offset into the file, in bytes.
`Archiver.PSD`	`getPSD()`
`Archiver.ToC`	`getToC()`
`boolean`	`isFinished()`
`boolean`	`isOpen()` Tells if the file is open.
`boolean`	`isOpen()` Tells if the file is open.
`boolean`	`open()` Open the file with the flags that have already been set.
`boolean`	`open(int flags)` Open a data connection with specified flags.
`boolean`	`open(int flags)` Open a data connection with specified flags.
`static Archiver`	`openForExport(nxm.sys.lib.Midas M, java.lang.String path, byte[] hdr, int dir)`
`int`	`read(long lbuf, byte[] buf, int boff, int bytes, int chan)`
`int`	`readExport(byte[] buf, long offset, int bytes)`
`void`	`setAAux(java.lang.String aux)`
`void`	`setAAux1(java.lang.String aux)`
`void`	`setAAux2(java.lang.String aux)`
`void`	`setCleanup(java.lang.String str)`
`void`	`setDur(double dur)`
`void`	`setEvent(java.lang.String str)`
`void`	`setFunc(java.lang.String function)`
`void`	`setMaxLines(int lines)`
`void`	`setMaxLineSize(double bytes)`
`void`	`setMulti(int channels)`
`void`	`setNChan(int channels)`
`void`	`setPktHeader(ICEPacket icepkh)`
`void`	`setThrottle(double rate)`
`void`	`setTime(double wsec, double fsec)` Sets the header timecode and always put `TC_PREC` keyword (even if it is zero) see `DataFile.getTime()` for details.
`void`	`setTime(nxm.sys.lib.Time time)` Sets the header timecode and always put `TC_PREC` keyword (even if it is zero) see `DataFile.getTime()` for details.
`static void`	`setTimeNicely(nxm.sys.lib.DataFile df, double wsec, double fsec)`
`void`	`setTimeNicely(nxm.sys.lib.DataFile df, nxm.sys.lib.Time time)`
`void`	`setTop(double top)`
`int`	`write(long lbuf, byte[] buf, int boff, int bytes, int chan)`
`int`	`write(long lbuf, int boff, int bytes, int chan)`
`int`	`writeExport(byte[] buf, int bytes)`

Methods inherited from class nxm.sys.lib.DataFile
addComp, addComp, addSubRec, addSubRec, addSubRec, addSubRec, align, avail, checkFormat, checkType, compare, compare, compare, connect, convertHeaderRep, convertHeaderRep, convertHeaderRep, convertRecordRep, copyHeader, createDataBuffer, createDataBuffer, createDataBuffer, deleteNonTimeLineKeywords, deleteTimeLineKeywords, equals, equals, equals, equals, equalsHeader, equalsKeywordsExt, erase, eraseFileName, find, findIndex, findRec, findRecOffset, getAPE, getAutoConvertPlatinum, getAutoConvertPlatinumDefault, getBlueIO, getBlueVer, getBPA, getBPE, getBPS, getCircularFileOffset, getClassVersion, getComment, getCompFormat, getCompName, getCompOffset, getCompType, getCompTypeID, getCompTypeName, getCompUnits, getCompUnitsName, getCompUnitsName, getConsLength, getCreator, getData, getData, getData, getDataBuffer, getDataBuffer, getDataBuffer, getDataMask, getDataRep, getDataSize, getDataStart, getDataStop, getDataT, getDataTable, getDataZ, getDelta, getDetached, getDetachExt, getDetachName, getExtended, getExtSize, getExtStart, getFormat, getFormatMode, getFormatModeName, getFormatType, getFormatTypeName, getFrameSize, getFS, getHeaderLength, getHeadRep, getInByte, getIndex, getIndex, getIndex, getIndex, getIndex, getIndex, getIndex, getIndex, getIndex, getIndexAt, getIndexAt, getInlet, getKeyLength, getKeyScope, getKeyWord, getKeyWord, getKeywords, getKeywordsObject, getMode, getNextDataFile, getNumberComponents, getNumberOfRows, getNumberSubRecords, getNumTimelineEntries, getNyquist, getOutByte, getOutlets, getOutMask, getPacket, getPacketHandler, getPacketHandlerFlags, getPartialBlueFileError, getPartialBlueFileError, getPipe, getPipeId, getPipeLoc, getPipeSize, getPreviousDataFile, getProtected, getQuadword, getQW, getRasterTuneAdjust, getRate, getRecCompType, getRecCompTypeName, getRecElements, getRecFormat, getRecFormatMode, getRecFormatType, getRecLength, getRecMaximum, getRecMinimum, getRecName, getRecName, getRecOffset, getRecord, getRecordDef, getRecordDefCount, getRecordDefs, getRecReserved, getRecUnits, getRecUnitsName, getRecUnitsPrefix, getReferenceFrame, getScalarSeparator, getSize, getSPA, getStart, getSubsize, getSubSize, getTime, getTimeAt, getTimeAt, getTimeAt, getTimeAtCurrent, getTimeAtCurrent, getTimeAtEnd, getTimeAtStart, getTimeCode, getTimeDuration, getTimeLineHandler, getTimeLineLength, getTimeLineTolerance, getTransLength, getTuneAdjustments, getType, getTypeCodeClass, getUniqueRecName, getUniqueRecName, getUnits, getUnitsID, getUnitsID, getUnitsName, getUnitsName, getUnitsNameShort, getUnitsNameShort, getUnitsVarName, getURL, getVersion, getXDelta, getXferLength, getXFrame, getXRate, getXStart, getXUnits, getXUnitsName, getYDelta, getYFrame, getYRate, getYStart, getYUnits, getYUnitsName, init, init, init, init, init, init, init, init, initMain, insertData, isAutoCorrectEnabled, isBlueFile, isBlueFileMagic, isBlueFileName, isCompleteBlueFile, isCompleteBlueFile, isFile, isJarFile, isPipe, isReady, isRecordBased, listElements, listElementsPerLine, listHeader, listKeywords, processReady, propagate, propagate, read, read, read, read, read, read, read, readDataTable, removeData, removeData, rename, reOpen, seek, seek, setAutoConvertPlatinum, setAutoConvertPlatinumDefault, setBlueIO, setBlueIO, setBlueVer, setBlueVer, setC, setCircularFileLength, setComment, setComp, setCompFormat, setCompName, setComponents, setCompType, setCompUnits, setConsLength, setCTG, setData, setData, setData, setData, setDataMask, setDataRep, setDataSize, setDataStart, setDelta, setDetached, setDetached, setDFS, setDS, setExtKw, setExtSize, setExtStart, setFlags, setFormat, setFormat, setFormatMode, setFormatType, setFrameSize, setFS, setHeadRep, setHeadRep, setInByte, setInlet, setInternals, setKeyLength, setKeyScope, setKeywords, setKWSB, setMainKw, setNumberComponents, setNumberSubRecords, setOutByte, setOutlets, setOutMask, setPacket, setPacketHandler, setPipeId, setPipeLoc, setPipeSize, setPreserveDataBuffer, setProtected, setQuadword, setQW, setRasterTuneAdjust, setRecElements, setRecFormat, setRecLength, setRecMaximum, setRecMinimum, setRecName, setRecOffset, setRecordDefs, setRecType, setRecUnits, setRecUnitsPrefix, setReferenceFrame, setSameTimeLineKeywords, setSameTimeLineKeywords, setSameTLKW, setSameTLKW, setScalarSeparator, setSize, setSize, setSR, setStart, setSubRec, setSubRecords, setSubsize, setSubSize, setTime, setTime, setTimeAt, setTimeAt, setTimeAt, setTimeAt, setTimeAt, setTimeAt, setTimeCode, setTimeCode, setTimeLineLength, setTimeLineObject, setTimeLineTolerance, setTransLength, setType, setType, setUnits, setVersion, setXDelta, setXferLength, setXRate, setXStart, setXUnits, setXUnits, setYDelta, setYRate, setYStart, setYUnits, setYUnits, skip, testRep, toString, trimmersFromTimes, update, updateKeywordsAndTimeLine, updateTimeLineFromKeywords, write, write, write, write, write, write, write, write, writeDataTable, writeHeader

Methods inherited from class nxm.sys.lib.BaseFile
compare, copy, delete, equalsBF, exists, getAux, getEntries, getFeqTolerance, getFileName, getFileNameFor, getFileNameFor, getFileNameFor, getFlags, getFlagsString, getFlagsString, getInstanceFor, getInstanceFor, getMimeType, getMimeType, getName, getQualifier, getQualifiers, getResource, getTag, hashCode, isDir, isOpen, isStream, isStreaming, open, parseFileTestFlag, readByte, setAux, setAux, setDefaultQualifier, setDefaultQualifiers, setExt, setExtDefault, setFeqTolerance, setFeqTolerance, setFlags, setName, setName, setOutput, setQualifier, setTag, status

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

Methods inherited from interface nxm.sys.inc.PlotFile
getQualifier, getTag, isStream, isStreaming

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

- Field Detail
  - propertyList
```
public static final java.lang.String propertyList
```
    Packet types list
    
    See Also:
    
    Constant Field Values
  - functionList
```
public static final java.lang.String functionList
```
    Packet modes list
    
    See Also:
    
    Constant Field Values
  - NORMAL
```
public static final int NORMAL
```
    Packet types
    
    See Also:
    
    Constant Field Values
  - ICEUNPACK
```
public static final int ICEUNPACK
```
    Packet types
    
    See Also:
    
    Constant Field Values
  - SDDSUNPACK
```
public static final int SDDSUNPACK
```
    Packet types
    
    See Also:
    
    Constant Field Values
  - ICEDEMUX
```
public static final int ICEDEMUX
```
    Packet types
    
    See Also:
    
    Constant Field Values
  - RAWMULTI
```
public static final int RAWMULTI
```
    Packet types
    
    See Also:
    
    Constant Field Values
  - ICEMULTI
```
public static final int ICEMULTI
```
    Packet types
    
    See Also:
    
    Constant Field Values
  - SDDSMULTI
```
public static final int SDDSMULTI
```
    Packet types
    
    See Also:
    
    Constant Field Values
  - VRTMULTI
```
public static final int VRTMULTI
```
    Packet types
    
    See Also:
    
    Constant Field Values
  - NIO
```
public static final int NIO
```
    Packet modes
    
    See Also:
    
    Constant Field Values
  - SDDSBUFSZ
```
public static final int SDDSBUFSZ
```
    Other constnts
    
    See Also:
    
    Constant Field Values
  - ICEBUFSZ
```
public static final int ICEBUFSZ
```
    Other constnts
    
    See Also:
    
    Constant Field Values
  - MAXNIOBUF
```
public static final int MAXNIOBUF
```
    Other constnts
    
    See Also:
    
    Constant Field Values
  - RAWMULTISZ
```
public static final int RAWMULTISZ
```
    Other constnts
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Archiver
```
public Archiver(sourcepic sp)
```
    Extensions to DataFile for archiving
    
    Parameters:
    
    sp - Sourcepic instance for this archive
  - Archiver
```
public Archiver()
```
    Extensions to DataFile for archiving
- Method Detail
  - getMulti
```
public int getMulti()
```
  - getFunc
```
public java.lang.String getFunc()
```
  - getMaxLines
```
public int getMaxLines()
```
  - getMaxLineSize
```
public double getMaxLineSize()
```
  - getEvent
```
public java.lang.String getEvent()
```
  - setMulti
```
public void setMulti(int channels)
```
  - setNChan
```
public void setNChan(int channels)
```
  - setFunc
```
public void setFunc(java.lang.String function)
```
  - setMaxLines
```
public void setMaxLines(int lines)
```
  - setMaxLineSize
```
public void setMaxLineSize(double bytes)
```
  - setEvent
```
public void setEvent(java.lang.String str)
```
  - setCleanup
```
public void setCleanup(java.lang.String str)
```
  - setThrottle
```
public void setThrottle(double rate)
```
  - open
```
public boolean open()
```
    Description copied from class: nxm.sys.lib.BaseFile
    
    Open the file with the flags that have already been set. Note that when the BaseFile.WAIT flag is set (or the file is a pipe) this method will wait for an input file to be created if it does not already exist.
    
    Overrides:
    
    open in class nxm.sys.lib.DataFile
    
    Returns:
    
    true if the file is successfully opened and false if not.
  - flush
```
public void flush()
```
    Description copied from class: nxm.sys.lib.BaseFile
    
    Flush any cached data to disk and update header.
    
    Overrides:
    
    flush in class nxm.sys.lib.DataFile
  - close
```
public void close()
```
    Description copied from class: nxm.sys.lib.BaseFile
    
    Close a data connection.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class nxm.sys.lib.DataFile
  - setPktHeader
```
public void setPktHeader(ICEPacket icepkh)
```
  - read
```
public int read(long lbuf,
                byte[] buf,
                int boff,
                int bytes,
                int chan)
```
  - write
```
public int write(long lbuf,
                 int boff,
                 int bytes,
                 int chan)
```
  - write
```
public int write(long lbuf,
                 byte[] buf,
                 int boff,
                 int bytes,
                 int chan)
```
  - addEventKey
```
public void addEventKey(java.lang.String key,
                        double value)
```
  - openForExport
```
public static Archiver openForExport(nxm.sys.lib.Midas M,
                                     java.lang.String path,
                                     byte[] hdr,
                                     int dir)
```
  - getExportSize
```
public long getExportSize()
```
  - readExport
```
public int readExport(byte[] buf,
                      long offset,
                      int bytes)
```
  - writeExport
```
public int writeExport(byte[] buf,
                       int bytes)
```
  - getToC
```
public Archiver.ToC getToC()
```
  - getPSD
```
public Archiver.PSD getPSD()
```
  - getLengthBytes
```
public double getLengthBytes()
```
  - getLength
```
public double getLength()
```
    Description copied from class: nxm.sys.lib.DataFile
    
    get length of file
    
    Overrides:
    
    getLength in class nxm.sys.lib.DataFile
    
    Returns:
    
    length of file (size * delta)
  - getOffset
```
public double getOffset()
```
    Description copied from class: nxm.sys.lib.BaseFile
    
    Get the current offset into the file, in bytes.
    
    Overrides:
    
    getOffset in class nxm.sys.lib.BaseFile
    
    Returns:
    
    the current file BaseFile.offset in bytes
    
    See Also:
    
    BaseFile.seek(), BaseFile.seek(double)
  - setAAux
```
public void setAAux(java.lang.String aux)
```
  - setAAux1
```
public void setAAux1(java.lang.String aux)
```
  - setAAux2
```
public void setAAux2(java.lang.String aux)
```
  - getChannelFreq
```
public double getChannelFreq()
```
  - getChannelTime
```
public nxm.sys.lib.Time getChannelTime()
```
  - getChannelFormat
```
public java.lang.String getChannelFormat()
```
  - 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)
```
  - findDemuxChannel
```
public int findDemuxChannel(long lbuf,
                            int boff,
                            int bytes)
```
  - checkChannels
```
public void checkChannels()
```
  - discontinue
```
public void discontinue()
```
  - isFinished
```
public boolean isFinished()
```
  - setTop
```
public void setTop(double top)
```
  - setDur
```
public void setDur(double dur)
```
  - setTime
```
public void setTime(nxm.sys.lib.Time time)
```
    Description copied from class: nxm.sys.lib.DataFile
    
    Sets the header timecode and always put TC_PREC keyword (even if it is zero) see DataFile.getTime() for details.
    
    Overrides:
    
    setTime in class nxm.sys.lib.DataFile
    
    Parameters:
    
    time - The Time object with wsec and fsec.
  - setTimeNicely
```
public void setTimeNicely(nxm.sys.lib.DataFile df,
                          nxm.sys.lib.Time time)
```
  - setTime
```
public void setTime(double wsec,
                    double fsec)
```
    Description copied from class: nxm.sys.lib.DataFile
    
    Sets the header timecode and always put TC_PREC keyword (even if it is zero) see DataFile.getTime() for details.
    
    Overrides:
    
    setTime in class nxm.sys.lib.DataFile
    
    Parameters:
    
    wsec - Whole seconds since 1 Jan 1950.
    
    fsec - Fractional seconds since 1 Jan 1950.
  - setTimeNicely
```
public static void setTimeNicely(nxm.sys.lib.DataFile df,
                                 double wsec,
                                 double fsec)
```
  - doFunc
```
public static int doFunc(java.lang.Object ref,
                         java.lang.String func,
                         java.lang.String fname,
                         double ttop,
                         double tdur,
                         java.lang.String event,
                         java.lang.String file)
```
  - getFileAt
```
public static java.lang.String getFileAt(java.lang.Object ref,
                                         java.lang.String fname,
                                         double ttop,
                                         double tdur,
                                         int xfer)
```
  - getLayer
```
@LimitedFutureSupport(value="plot now uses a registry to find the appropriate getLayer method, rather than accessing a PlotFile instance method")
public nxm.sys.libg.Layer getLayer()
```
    Get the default Layer on which this file is plotted. Removing libg dependencies from lib due to JDK 11+ Modularity. Since NeXtMidas 3.9.2 See JDK_Modularity_User_Action_Required.xlxs for more details.
    
    Returns:
    
    The default layer to use, or null to let PLOT decide.
  - getLayer
```
@Deprecated
 @InternalUseOnly
public nxm.sys.libg.Layer getLayer(int plotType)
```
    Deprecated. Removing libg dependencies from lib due to JDK 11+ Modularity. Since NeXtMidas 3.9.1
    
    Special version of getLayer() that is used internal to Layer. This is necessary since DataFile supports so many types and needs to know some of the PLOT options in order to determine which layer type to use. This version is for internal use only and may change without notice.
    
    Parameters:
    
    plotType - plot type
    
    Returns:
    
    layer
    
    Since:
    
    NeXtMidas 3.3.2
  - getName
```
public nxm.sys.lib.FileName getName()
```
    Get the file name for the file, with any qualifiers and trimmers.
    
    Returns:
    
    The file name, or null if not set yet.
  - open
```
public boolean open(int flags)
```
    Open a data connection with specified flags. If the file name is blank and the BaseFile.OPTIONAL flag is specified.
    
    Parameters:
    
    flags - The flags to use (see BaseFile for a list of available "I/O open flags."
    
    Returns:
    
    true if the file is now open, false if unable to open the file (with BaseFile.NOABORT or BaseFile.OPTIONAL).
    
    Throws:
    
    java.lang.RuntimeException - If unable to open the file and NOT using BaseFile.NOABORT or BaseFile.OPTIONAL.
  - isOpen
```
public boolean isOpen()
```
    Tells if the file is open.
    
    Returns:
    
    true if the file is open, false otherwise.
  - getName
```
public nxm.sys.lib.FileName getName()
```
    Get the file name for the file, with any qualifiers and trimmers.
    
    Returns:
    
    The file name, or null if not set yet.
  - open
```
public boolean open(int flags)
```
    Open a data connection with specified flags. If the file name is blank and the BaseFile.OPTIONAL flag is specified.
    
    Parameters:
    
    flags - The flags to use (see BaseFile for a list of available "I/O open flags."
    
    Returns:
    
    true if the file is now open, false if unable to open the file (with BaseFile.NOABORT or BaseFile.OPTIONAL).
    
    Throws:
    
    java.lang.RuntimeException - If unable to open the file and NOT using BaseFile.NOABORT or BaseFile.OPTIONAL.
  - isOpen
```
public boolean isOpen()
```
    Tells if the file is open.
    
    Returns:
    
    true if the file is open, false otherwise.

Class Archiver

Nested Class Summary

Field Summary

Fields inherited from class nxm.sys.lib.DataFile

Fields inherited from class nxm.sys.lib.BaseFile

Fields inherited from interface nxm.sys.inc.PlotFile

Fields inherited from interface nxm.sys.inc.AsciiMap

Fields inherited from interface nxm.sys.inc.DataTypes

Constructor Summary

Method Summary

Methods inherited from class nxm.sys.lib.DataFile

Methods inherited from class nxm.sys.lib.BaseFile

Methods inherited from class java.lang.Object

Methods inherited from interface nxm.sys.inc.PlotFile

Methods inherited from interface nxm.sys.inc.DataTypes

Field Detail

propertyList

functionList

NORMAL

ICEUNPACK

SDDSUNPACK

ICEDEMUX

RAWMULTI

ICEMULTI

SDDSMULTI

VRTMULTI

NIO

SDDSBUFSZ

ICEBUFSZ

MAXNIOBUF

RAWMULTISZ

Constructor Detail

Archiver

Archiver

Method Detail

getMulti

getFunc

getMaxLines

getMaxLineSize

getEvent

setMulti

setNChan

setFunc

setMaxLines

setMaxLineSize

setEvent

setCleanup

setThrottle

open

flush

close

setPktHeader

read

write

write

addEventKey

openForExport

getExportSize

readExport

writeExport

getToC

getPSD

getLengthBytes

getLength

getOffset

setAAux

setAAux1

setAAux2

getChannelFreq

getChannelTime

getChannelFormat

getChannel

getChannel

getChannels

findSDDSChannel

findDemuxChannel

checkChannels

discontinue

isFinished

setTop