class Packet

This is the abstract packet class

Inheritance:


Public Methods

[more]inline virtual ~Packet()
the virtual destructor
[more]virtual int iValue(const int channel)
iValue returns the value of a given channel as an int.
[more]virtual int iValue(const int channel, const char * what)
with the "what" parameter you can decide which aspect of the data you want to see (for devices which have more than one)
[more]virtual int iValue(const int channel, const int iy)
this supports devices which are inherently organized as two-dimensional data, such as flash ADC's (channel vs time slice)
[more]virtual float rValue(const int channel)
rValue returns the value of a given channel as a float
[more]virtual float rValue(const int channel, const char * what)
with the "what" parameter you can decide which aspect of the data you want to see (for devices which have more than one)
[more]virtual float rValue(const int channel, const int iy)
this supports devices which are inherently organized as two-dimensional data, such as flash ADC's (channel vs time slice)
[more]virtual int getArraylength(const char * what ="")
getArraylength returns the length of the array needed to store the decoded values
[more]virtual int fillIntArray(int destination[], const int length, int * nw, const char * what="")
fillIntArray and fillFloatArray fill existing (user-supplied) arrays with the decoded data
[more]virtual int fillFloatArray(float destination[], const int length, int * nw, const char * what="")
fillFloatArray fills an array of floats
[more]virtual int* getIntArray(int * nw, const char * ="")
getIntArray and getFloatArray create a new array of the approriate size fill it with the decoded values, and return a pointer to the array.
[more]virtual float* getFloatArray(int * nw, const char * ="")
getFloatArray creates and returns an array of floats
[more]virtual int is_pointer_type() const
find out what type (pointer- or data based) packet object we have
[more]virtual int convert()
convert from pointer- to data based object, if it is already data-based, do nothing.
[more]virtual int getLength() const
getLength() returns the length of the raw packet data.
[more]virtual int getDebugLength() const
get the length of the debug block
[more]virtual int getIdentifier() const
get the packet identifier
[more]virtual int getPadding() const
get the number of padding units in the packet data.
[more]virtual int getStructure() const
get the structure of the packet data; unformatted, hitlist, etc.
[more]virtual int getHitFormat() const
get the hit format; in case of unformatted get the encoding scheme.
[more]virtual int getDataLength() const
get what the name says...
[more]virtual voidfullIdentify (std::ostream& os = std::cout) const (ostream & os = cout) const
write an indepth identification message to the supplied OSTREAM.
[more]virtual void dump(std::ostream& os = std::cout)
dump (either to standard output or the specified OSTREAM) the packet's data in some packet-specific way.
[more]virtual void gdump(const int how = EVT_HEXADECIMAL, std::ostream& os = std::cout) const
Since dump() requires the packet data to be consistent, gdump ("generic" dump) dumps the data without making assumptions about the integrity of the packet data.

Public

[more]
see below for comments


Documentation

This is the abstract packet class
oinline virtual ~Packet()
the virtual destructor

ovirtual int iValue(const int channel)
iValue returns the value of a given channel as an int.

ovirtual int iValue(const int channel, const char * what)
with the "what" parameter you can decide which aspect of the data you want to see (for devices which have more than one)

ovirtual int iValue(const int channel, const int iy)
this supports devices which are inherently organized as two-dimensional data, such as flash ADC's (channel vs time slice)

ovirtual float rValue(const int channel)
rValue returns the value of a given channel as a float

ovirtual float rValue(const int channel, const char * what)
with the "what" parameter you can decide which aspect of the data you want to see (for devices which have more than one)

ovirtual float rValue(const int channel, const int iy)
this supports devices which are inherently organized as two-dimensional data, such as flash ADC's (channel vs time slice)

ovirtual int getArraylength(const char * what ="")
getArraylength returns the length of the array needed to store the decoded values

ovirtual int fillIntArray(int destination[], const int length, int * nw, const char * what="")
fillIntArray and fillFloatArray fill existing (user-supplied) arrays with the decoded data

ovirtual int fillFloatArray(float destination[], const int length, int * nw, const char * what="")
fillFloatArray fills an array of floats

ovirtual int* getIntArray(int * nw, const char * ="")
getIntArray and getFloatArray create a new array of the approriate size fill it with the decoded values, and return a pointer to the array. nw is the length of the array created.

ovirtual float* getFloatArray(int * nw, const char * ="")
getFloatArray creates and returns an array of floats

ovirtual int is_pointer_type() const
find out what type (pointer- or data based) packet object we have

ovirtual int convert()
convert from pointer- to data based object, if it is already data-based, do nothing.

ovirtual int getLength() const
getLength() returns the length of the raw packet data. If you were to copy the data somewhere, the destination must be able to hold as many words.

ovirtual int getDebugLength() const
get the length of the debug block

ovirtual int getIdentifier() const
get the packet identifier

ovirtual int getPadding() const
get the number of padding units in the packet data.

ovirtual int getStructure() const
get the structure of the packet data; unformatted, hitlist, etc.

ovirtual int getHitFormat() const
get the hit format; in case of unformatted get the encoding scheme.

ovirtual int getDataLength() const
get what the name says...

o
see below for comments

ovirtual voidfullIdentify (std::ostream& os = std::cout) const (ostream & os = cout) const
write an indepth identification message to the supplied OSTREAM.

ovirtual void dump(std::ostream& os = std::cout)
dump (either to standard output or the specified OSTREAM) the packet's data in some packet-specific way.

ovirtual void gdump(const int how = EVT_HEXADECIMAL, std::ostream& os = std::cout) const
Since dump() requires the packet data to be consistent, gdump ("generic" dump) dumps the data without making assumptions about the integrity of the packet data. For many Packet classes dump just calls gdump because it is good enough. The "how" parameter for gdump specifies decimal, octal, or hexadecimal (0,1,2) dump.


Direct child classes:
Packet_A

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.