Packet type buffers
Packet type documenation buffers provide information
about the types of packets that can appear in the
physics data stream. When you use the documented
packet class (see Using documented packets),
each instance of a CDocumentedPacket registers
itself to have a description placed in the
documented packet buffer.
The body of a documented packet buffer is a series
of null terminated strings. The strings always
start on word boundaries. If necessary a string
is padded with a blank to ensure this.
Each string consists of 5 colon separated fields.
The fields are in order:
- Name the name of the packet.
- id The id value of the packet formatted
as a hexadecimal string.
- description A description of the packet.
- Version A string giving the version of the
packet format.
- date The data at which the packet object was
instantiated (usually about when the Readout
program was started, or when the first run was
started).
- The entity count of a packet documentation
buffer will be the number of strings in the
buffer body.
- If all of the documentation strings don't fit into
a single buffer, several documentation buffers will
be emitted.
- Documentation buffers are emitted whenever
the run becomes Active (begin or resume).
Report documentation errors to
Ron Fox
(fox@nscl.msu.edu)or
NSCL's Bugzilla page
