public class Archiver
extends nxm.sys.lib.DataFile
| Modifier and Type | Class and Description |
|---|---|
class |
Archiver.Channel |
class |
Archiver.PSD |
static class |
Archiver.ToC |
static class |
Archiver.ToCR |
| 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
|
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, xferLengthALWAYSREOPEN, 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, ZIPT_CONT, T_DOT, T_LINE, T_MESH, T_POINT, T_RASTER, typeListBANG, 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, ZEROALAW, 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 and Description |
|---|
Archiver()
Extensions to DataFile for archiving
|
Archiver(sourcepic sp)
Extensions to DataFile for archiving
|
| 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) |
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, writeHeadercompare, 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, statuspublic static final java.lang.String propertyList
public static final java.lang.String functionList
public static final int NORMAL
public static final int ICEUNPACK
public static final int SDDSUNPACK
public static final int ICEDEMUX
public static final int RAWMULTI
public static final int ICEMULTI
public static final int SDDSMULTI
public static final int VRTMULTI
public static final int NIO
public static final int SDDSBUFSZ
public static final int ICEBUFSZ
public static final int MAXNIOBUF
public static final int RAWMULTISZ
public Archiver(sourcepic sp)
sp - Sourcepic instance for this archivepublic Archiver()
public int getMulti()
public java.lang.String getFunc()
public int getMaxLines()
public double getMaxLineSize()
public java.lang.String getEvent()
public void setMulti(int channels)
public void setNChan(int channels)
public void setFunc(java.lang.String function)
public void setMaxLines(int lines)
public void setMaxLineSize(double bytes)
public void setEvent(java.lang.String str)
public void setCleanup(java.lang.String str)
public void setThrottle(double rate)
public boolean open()
nxm.sys.lib.BaseFileBaseFile.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.open in class nxm.sys.lib.DataFiletrue if the file is successfully opened and false if not.public void flush()
nxm.sys.lib.BaseFileflush in class nxm.sys.lib.DataFilepublic void close()
nxm.sys.lib.BaseFileclose in interface java.io.Closeableclose in interface java.lang.AutoCloseableclose in class nxm.sys.lib.DataFilepublic void setPktHeader(ICEPacket icepkh)
public int read(long lbuf,
byte[] buf,
int boff,
int bytes,
int chan)
public int write(long lbuf,
int boff,
int bytes,
int chan)
public int write(long lbuf,
byte[] buf,
int boff,
int bytes,
int chan)
public void addEventKey(java.lang.String key,
double value)
public static Archiver openForExport(nxm.sys.lib.Midas M, java.lang.String path, byte[] hdr, int dir)
public long getExportSize()
public int readExport(byte[] buf,
long offset,
int bytes)
public int writeExport(byte[] buf,
int bytes)
public Archiver.ToC getToC()
public Archiver.PSD getPSD()
public double getLengthBytes()
public double getLength()
nxm.sys.lib.DataFilegetLength in class nxm.sys.lib.DataFilepublic double getOffset()
nxm.sys.lib.BaseFilegetOffset in class nxm.sys.lib.BaseFileBaseFile.offset in bytesBaseFile.seek(),
BaseFile.seek(double)public void setAAux(java.lang.String aux)
public void setAAux1(java.lang.String aux)
public void setAAux2(java.lang.String aux)
public double getChannelFreq()
public nxm.sys.lib.Time getChannelTime()
public java.lang.String getChannelFormat()
public Archiver.Channel getChannel()
public Archiver.Channel getChannel(int i)
public nxm.sys.lib.KeyVector getChannels()
public int findSDDSChannel(long lbuf,
int boff,
int bytes)
public int findDemuxChannel(long lbuf,
int boff,
int bytes)
public void checkChannels()
public void discontinue()
public boolean isFinished()
public void setTop(double top)
public void setDur(double dur)
public void setTime(nxm.sys.lib.Time time)
nxm.sys.lib.DataFileTC_PREC keyword (even if it is zero) see DataFile.getTime() for details.setTime in class nxm.sys.lib.DataFiletime - The Time object with wsec and fsec.public void setTimeNicely(nxm.sys.lib.DataFile df,
nxm.sys.lib.Time time)
public void setTime(double wsec,
double fsec)
nxm.sys.lib.DataFileTC_PREC keyword (even if it is zero) see DataFile.getTime() for details.setTime in class nxm.sys.lib.DataFilewsec - Whole seconds since 1 Jan 1950.fsec - Fractional seconds since 1 Jan 1950.public static void setTimeNicely(nxm.sys.lib.DataFile df,
double wsec,
double fsec)
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)
public static java.lang.String getFileAt(java.lang.Object ref,
java.lang.String fname,
double ttop,
double tdur,
int xfer)
@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()
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.null to let PLOT decide.@Deprecated @InternalUseOnly public nxm.sys.libg.Layer getLayer(int plotType)
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.plotType - plot typepublic nxm.sys.lib.FileName getName()
public boolean open(int flags)
BaseFile.OPTIONAL flag is specified.flags - The flags to use (see BaseFile for a list of available "I/O
open flags."BaseFile.NOABORT or BaseFile.OPTIONAL).java.lang.RuntimeException - If unable to open the file and NOT using
BaseFile.NOABORT or BaseFile.OPTIONAL.public boolean isOpen()
public nxm.sys.lib.FileName getName()
public boolean open(int flags)
BaseFile.OPTIONAL flag is specified.flags - The flags to use (see BaseFile for a list of available "I/O
open flags."BaseFile.NOABORT or BaseFile.OPTIONAL).java.lang.RuntimeException - If unable to open the file and NOT using
BaseFile.NOABORT or BaseFile.OPTIONAL.public boolean isOpen()