PacketTable( )IsValid() is called on it. To create a valid
packet table, use the FL_Packet_Table constructors.
This function does not make any change to the underlying
HDF5 file.
PacketTable(hid_t fileID, const char* ptname)PacketTable(hid_t fileID, char* ptname)
(deprecated)ptname,
which can contain either fixed-length or variable-length
packets.hid_t fileIDconst char* ptname| Release | Change |
| 1.10.0 and 1.8.17 | Function parameters were revised. |
~PacketTable()bool IsValid()int IsVariableLength()1 if this packet table uses
a variable-length datatype, 0 if not, and
FAIL if failure occurs.1, 0, or FAIL.
| Release | Change |
| 1.10.0 and 1.8.17 | Function introduced. |
void ResetIndex()GetNextPacket.int SetIndex(hsize_t index);hsize_t indexhsize_t GetIndex(int& error);
If GetIndex returns 0 (zero),
you must then check the value of the parameter error.
If error is negative, GetIndex
has failed; if error is 0 (zero),
the position of the current packet is 0 (zero).
int& error (optional)0 (zero) on error.hsize_t GetPacketCount()hsize_t GetPacketCount(int& error)error is not
supplied, any error value is ignored. Using this parameter allows
the user to distinguish between an open packet table with 0
packets and an invalid packet table.int& error (optional)0 if
packet table contains zero packets or on error.hid_t GetDatatype ()H5I_INVALID_HID on error.| Release | Change |
| 1.10.0 and 1.8.17 | Function introduced. |
hid_t GetDataset ()H5I_INVALID_HID on error.| Release | Change |
| 1.10.0 and 1.8.17 | Function introduced. |
hid_t GetTableId ()H5I_INVALID_HID if the packet table is not valid.| Release | Change |
| 1.10.0 and 1.8.17 | Function introduced. |
FreeBuff(size_t numStructs, hvl_t * buffer)hvl_t structs to be freed and
a pointer to their location in memory.size_t numStructshvl_t *bufferSUCCEED on success and
FAIL on error.| Release | Change |
| 1.10.0 and 1.8.17 | Function introduced in this release. |
FL_PacketTable(hid_t fileID, const char* ptname,
hid_t dtypeID, hsize_t chunkSize)ptname, in the file specified by fileID.
Packets will be of the datatype specified by dtypeID.
The packet table uses HDF5 chunked storage to allow it to
grow. The chunk size can be specified by chunkSize.
The chunk size affects performance, so it should be determined
with care when performance is important. hid_t fileIDconst char * ptnamehid_t dtypeIDhsize_t chunkSize| Release | Change |
| 1.10.0 | Function revised. |
FL_PacketTable(hid_t fileID, const char* ptname, hid_t dtypeID,
hsize_t chunkSize, int compression)
This constructor creates and opens a packet table in the file
specified by fileID named ptname.
Packets will be of the datatype specified by
dtypeID. The packet can be specified to contain
data with deflate compression using the parameter
compression.
hid_t fileIDconst char * ptnamehid_t dtypeIDhsize_t chunkSizeint compression0 (zero) through
9, or -1 for no compression.| Release | Change |
| 1.10.0 and 1.8.17 | Function revised and deprecated. |
FL_PacketTable(hid_t fileID, const char* ptname)FL_PacketTable(hid_t fileID, char* ptname)
(deprecated)ptname in the location fileID. This
packet table can be either fixed-length or variable-length.hid_t fileIDconst char * ptname| Release | Change |
| 1.10.0 and 1.8.17 | Function arguments were changed. |
int AppendPacket(void * data)int AppendPackets(size_t numPackets, void *data)size_t numPacketsSUCCEED on success and FAIL
on error.| Release | Change |
| 1.10.0 and 1.8.17 | Function changed: function now works with fixed-length and variable-length packets. |
int GetPacket(hsize_t index, void * data)int GetPackets(hsize_t startIndex, hsize_t endIndex,
void * data)data, with fixed-length
packets from the packet table. The one-argument function can be
called to retrieve a single packet at the given index, or the
two-argument function can be used to read a range of packets
(zero-indexed, inclusive).hsize_t index (single packet)hsize_t startIndex (multiple packets)hsize_t endIndex (multiple packets)void * dataSUCCEED on success and FAIL
on error.int GetNextPacket(void * data)int GetNextPackets(size_t numPackets, void * data)ResetIndex and SetIndex functions
to iterate through the packet table. GetNextPacket
reads a single packet, and GetNextPackets reads
numPackets packets.size_t numPackets (optional)void * dataSUCCEED on success and FAIL
on error.