Analysis Software
Documentation for sPHENIX simulation software
|
#include <online_distribution/blob/master/newbasic/packet.h>
Public Member Functions | |
virtual | ~Packet () |
the virtual destructor | |
virtual int | iValue (const int)=0 |
iValue returns the value of a given channel as an int. | |
virtual int | iValue (const int, const char *)=0 |
virtual int | iValue (const int, const int, const char *)=0 |
virtual int | iValue (const int, const int)=0 |
virtual int | iValue (const int, const int, const int)=0 |
virtual int | iValue (const int, const int, const int, const char *)=0 |
virtual float | rValue (const int)=0 |
virtual double | dValue (const int channel) |
virtual double | dValue (const int channel, const char *what) |
virtual double | dValue (const int channel, const int iy) |
virtual long long | lValue (const int channel) |
virtual long long | lValue (const int channel, const char *what) |
virtual long long | lValue (const int channel, const int iy) |
virtual long long | lValue (const int channel, const int iy, const char *what) |
virtual float | rValue (const int, const char *)=0 |
virtual float | rValue (const int, const int)=0 |
virtual void * | pValue (const int) |
virtual void * | pValue (const int, const char *) |
virtual void * | pValue (const int, const int) |
virtual int | getArraylength (const char *what="")=0 |
virtual int | fillIntArray (int destination[], const int, int *, const char *what="")=0 |
virtual int | fillFloatArray (float destination[], const int, int *, const char *what="")=0 |
fillFloatArray fills an array of floats | |
virtual int * | getIntArray (int *, const char *="")=0 |
virtual float * | getFloatArray (int *, const char *="")=0 |
getFloatArray creates and returns an array of floats | |
virtual int | is_pointer_type () const =0 |
find out what type (pointer- or data based) packet object we have | |
virtual int | convert ()=0 |
convert from pointer- to data based object, if it is already data-based, do nothing. | |
virtual int | getLength () const =0 |
virtual int | getErrorLength () const =0 |
virtual int | getDebugLength () const =0 |
get the length of the debug block | |
virtual int | getIdentifier () const =0 |
get the packet identifier | |
virtual int | getPadding () const =0 |
get the number of padding units in the packet data. | |
virtual int | getStructure () const =0 |
get the structure of the packet data; unformatted, hitlist, etc. | |
virtual int | getHitFormat () const =0 |
get the hit format; in case of unformatted get the encoding scheme. | |
virtual int | getDataLength () const =0 |
get what the name says... | |
virtual void | identify (std::ostream &os=std::cout) const =0 |
see below for comments | |
virtual int | setIdentifier (const int)=0 |
set a new packet identifier | |
virtual void | fullIdentify (std::ostream &os=std::cout) const |
write an indepth identification message to the supplied OSTREAM. | |
virtual void | dump (std::ostream &os=std::cout)=0 |
virtual void | gdump (const int how=EVT_HEXADECIMAL, std::ostream &os=std::cout) const =0 |
virtual int | getCheckSumStatus () const |
virtual int | copyMe (int[], const int) const |
virtual int | setInternalParameter (const int p1=0, const int p2=0, const char *what="")=0 |
This is the abstract packet class.
Definition at line 20 of file packet.h.
View newest version in sPHENIX GitHub at line 20 of file packet.h
|
inlinevirtual |
|
pure virtual |
convert from pointer- to data based object, if it is already data-based, do nothing.
Implemented in Packet_A, and oncsSubevent.
Referenced by SingleZdcInput::FillPool(), and SinglePrdfInput::FillPool().
|
inlinevirtual |
Reimplemented in Packet_A, and oncsSubevent.
Definition at line 272 of file packet.h.
View newest version in sPHENIX GitHub at line 272 of file packet.h
Referenced by ospEvent::addPacket(), and oEvent::addPacket().
|
pure virtual |
dump (either to standard output or the specified OSTREAM) the packet's data in some packet-specific way.
Referenced by main(), TempInfoUnpackPRDF::process_event(), MvtxRunInfoUnpackPRDF::process_event(), and TPCFEETestRecov1::process_event().
|
inlinevirtual |
dValue returns the value of a given channel as a double
Reimplemented in oncsSub_idbspetdata, oncsSub_idrcpetdata, oncsSub_iduppetdata, and oncsSub_iduppetdata_v104.
Definition at line 90 of file packet.h.
View newest version in sPHENIX GitHub at line 90 of file packet.h
|
inlinevirtual |
Reimplemented in Packet_cdevpolarimeter, Packet_cdevdvm, Packet_cdevmadch, Packet_cdevbuckets, Packet_cdevir, Packet_cdevring, and Packet_cdevringnopol.
Definition at line 93 of file packet.h.
View newest version in sPHENIX GitHub at line 93 of file packet.h
|
inlinevirtual |
|
pure virtual |
fillFloatArray fills an array of floats
Implemented in Packet_A, and oncsSubevent.
|
pure virtual |
fillIntArray and fillFloatArray fill existing (user-supplied) arrays with the decoded data
Implemented in Packet_A, oncsSubevent, and Packet_gl1p.
Referenced by tpc_pool::addPacket().
|
inlinevirtual |
|
pure virtual |
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.
Referenced by main().
|
pure virtual |
getArraylength returns the length of the array needed to store the decoded values.
Implemented in Packet_A, and oncsSubevent.
|
inlinevirtual |
|
pure virtual |
get what the name says...
Implemented in Packet_A, and oncsSubevent.
Referenced by tpc_pool::addPacket().
|
pure virtual |
get the length of the debug block
Implemented in Packet_A, and oncsSubevent.
|
pure virtual |
Implemented in Packet_A, and oncsSubevent.
|
pure virtual |
getFloatArray creates and returns an array of floats
Implemented in Packet_A, and oncsSubevent.
|
pure virtual |
get the hit format; in case of unformatted get the encoding scheme.
Implemented in Packet_A, and oncsSubevent.
Referenced by TpcMon::process_event().
|
pure virtual |
get the packet identifier
Implemented in Packet_A, and oncsSubevent.
Referenced by intt_pool::addPacket(), Fun4AllPrdfInputPoolManager::AddPacket(), TempInfoUnpackPRDF::addPacketInfo(), EventNumberCheck::CheckFem(), SingleTpcPoolInput::FillPool(), SingleZdcInput::FillPool(), SingleMicromegasPoolInput::FillPool(), SingleInttPoolInput::FillPool(), SinglePrdfInput::FillPool(), SingleMvtxPoolInput::FillPool(), PktSizeMon::process_event(), MvtxMon::process_event(), and Fun4AllEventOutStream::WriteEvent().
|
pure virtual |
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.
Implemented in Packet_A, and oncsSubevent.
|
pure virtual |
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.
Implemented in Packet_A, and oncsSubevent.
Referenced by ospEvent::addPacket(), oEvent::addPacket(), TPCFEETestRecov1::get_motor_loc(), PktSizeMon::process_event(), SepdMon::process_event(), HcalMon::process_event(), and Fun4AllEventOutStream::WriteEvent().
|
pure virtual |
get the number of padding units in the packet data.
Implemented in Packet_A, and oncsSubevent.
|
pure virtual |
get the structure of the packet data; unformatted, hitlist, etc.
Implemented in Packet_A, and oncsSubevent.
|
pure virtual |
see below for comments
write an identification message to the supplied OSTREAM.
Referenced by tpc_pool::addPacket(), SingleGl1PoolInput::FillPool(), SingleInttPoolInput::FillPool(), SingleMvtxPoolInput::FillPool(), main(), TempInfoUnpackPRDF::process_event(), MvtxMon::process_event(), and TPCFEETestRecov1::process_event().
|
pure virtual |
find out what type (pointer- or data based) packet object we have
Implemented in Packet_A, and oncsSubevent.
|
pure virtual |
iValue returns the value of a given channel as an int.
Implemented in Packet_A, oncsSubevent, oncsSub_idmvtxv2, Packet_starscaler, oncsSub_idmvtxv1, Packet_idcstr, oncsSub_iduppetparams, Packet_gl1psum, oncsSub_idcaenv1742, oncsSub_idcaenv792, oncsSub_idcstr, and oncsSub_idgl1v0.
Referenced by intt_pool::addPacket(), TempInfoUnpackPRDF::addPacketInfo(), HcalMon::anaWaveform(), ZdcMon::anaWaveformFast(), SepdMon::anaWaveformFast(), CemcMon::anaWaveformFast(), SepdMon::anaWaveformTemp(), CemcMon::anaWaveformTemp(), EventNumberCheck::CheckFem(), SingleZdcInput::FillPool(), SingleMvtxPoolInput::FillPool(), SinglePrdfInput::FillPool(), TPCFEETestRecov1::get_motor_loc(), HcalMon::getSignal(), SepdMon::getSignal(), CemcMon::getSignal(), caen_correction::init(), ll1setup(), MvtxPrototype2UnpackPRDF::MakeHits(), MvtxUnpackPRDF::MakeHits(), process_event(), LL1Mon::process_event(), RunInfoUnpackPRDF::process_event(), EventInfoSummary::process_event(), SepdMon::process_event(), GenericUnpackPRDF::process_event(), ZdcMon::process_event(), CaloUnpackPRDF::process_event(), CemcMon::process_event(), HcalMon::process_event(), TemplateCreation::process_event(), TpcMon::process_event(), InttRawDataDecoder::process_event(), CaloTowerBuilder::process_event(), InttRawDataConverter::process_event(), LEDTowerBuilder::process_event(), MvtxMon::process_event(), InttMon::process_event(), tpc_hits::process_event(), TPCFEETestRecov1::process_event(), TpcRawDataDecoder::process_event(), OnlBbcEvent::setRawData(), and MbdEvent::SetRawData().
|
pure virtual |
with the "what" parameter you can decide which aspect of the data you want to see (for devices which have more than one)
Implemented in Packet_gl1, Packet_cdevpolarimeter, Packet_A, Packet_id4scaler, Packet_fvtx_dcm0, Packet_gl1p, oncsSubevent, Packet_cdevpoltarget, Packet_cdevbpm, Packet_hbd_fpga, Packet_hbd_fpgashort, oncsSub_idmvtxv2, oncsSub_idinttv0, oncsSub_idmvtxv3, Packet_cdevmadch, Packet_cdevbuckets, Packet_cdevring, Packet_cdevringnopol, Packet_starscaler, oncsSub_idmvtxv0, Packet_cdevwcm, oncsSub_idtpcfeev2, oncsSub_idmvtxv1, oncsSub_idtpcfeev3, oncsSub_iddreamv0, oncsSub_idfnalmwpcv2, oncsSub_idfnalmwpc, oncsSub_idsrs_v01, oncsSub_idbspetdata, oncsSub_idcaenv1742, oncsSub_idrcpetdata, oncsSub_idtpcfeev1, oncsSub_iduppetdata, oncsSub_iduppetdata_v104, oncsSub_iduppetparams, Packet_gl1_evclocks, Packet_gl1psum, Packet_iddigitizerv2, Packet_iddigitizerv3, Packet_idll1v1, oncsSub_idcaenv792, oncsSub_iddigitizerv1, oncsSub_idsis3300, and oncsSub_iddrs4v1.
|
pure virtual |
we have a few recent devices which have one more dimension (such as card, time sample, channel)
Implemented in Packet_A, oncsSubevent, oncsSub_idmvtxv2, oncsSub_idmvtxv3, oncsSub_idinttv0, oncsSub_idfnalmwpcv2, oncsSub_idmvtxv1, oncsSub_iddreamv0, oncsSub_idfnalmwpc, oncsSub_idtpcfeev2, and oncsSub_idsrs_v01.
|
pure virtual |
this supports devices which are inherently organized as two-dimensional data, such as flash ADC's (channel vs time slice)
Implemented in Packet_gl1, Packet_A, Packet_fvtx_dcm0, Packet_gl1p, oncsSubevent, oncsSub_idmvtxv2, Packet_hbd_fpga, Packet_hbd_fpgashort, oncsSub_idmvtxv0, oncsSub_idmvtxv1, oncsSub_idinttv0, oncsSub_iddreamv0, oncsSub_idtpcfeev2, oncsSub_idtpcfeev3, Packet_gl1_evclocks, oncsSub_idcaenv1742, oncsSub_idsis3300r, oncsSub_idtpcfeev1, Packet_iddigitizerv2, Packet_iddigitizerv3, Packet_idll1v1, oncsSub_iddigitizerv1, and oncsSub_idsis3300.
|
pure virtual |
this supports devices organized as three-dimensional data (card vs channel vs time slice )
Implemented in Packet_A, oncsSubevent, oncsSub_idmvtxv2, oncsSub_idfnalmwpcv2, oncsSub_idmvtxv0, oncsSub_idfnalmwpc, oncsSub_idmvtxv1, oncsSub_iddreamv0, oncsSub_idsrs_v01, oncsSub_idtpcfeev2, and oncsSub_idtpcfeev1.
|
pure virtual |
this supports devices organized as three-dimensional data (card vs channel vs time slice, with a "what" selection )
Implemented in Packet_A, oncsSubevent, oncsSub_idfnalmwpcv2, oncsSub_idmvtxv3, oncsSub_idfnalmwpc, and oncsSub_idtpcfeev2.
|
inlinevirtual |
lValue returns the value of a given channel as a long long
Reimplemented in Packet_starscaler, oncsSub_idbspetdata, oncsSub_idrcpetdata, oncsSub_iduppetdata, and oncsSub_iduppetdata_v104.
Definition at line 100 of file packet.h.
View newest version in sPHENIX GitHub at line 100 of file packet.h
Referenced by SingleGl1PoolInput::FillPool(), SingleMvtxPoolInput::FillPool(), HcalMon::process_event(), InttRawDataDecoder::process_event(), InttRawDataConverter::process_event(), MvtxMon::process_event(), and TpcRawDataDecoder::process_event().
|
inlinevirtual |
Reimplemented in Packet_id4scaler, oncsSub_idinttv0, oncsSub_idtpcfeev3, and oncsSub_idgl1v0.
Definition at line 103 of file packet.h.
View newest version in sPHENIX GitHub at line 103 of file packet.h
|
inlinevirtual |
Reimplemented in oncsSub_idinttv0, and oncsSub_idgl1v0.
Definition at line 106 of file packet.h.
View newest version in sPHENIX GitHub at line 106 of file packet.h
|
inlinevirtual |
Reimplemented in oncsSub_idmvtxv3.
Definition at line 109 of file packet.h.
View newest version in sPHENIX GitHub at line 109 of file packet.h
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
pure virtual |
rValue returns the value of a given channel as a float
Implemented in Packet_A, and oncsSubevent.
Referenced by process_event().
|
pure virtual |
with the "what" parameter you can decide which aspect of the data you want to see (for devices which have more than one)
Implemented in Packet_cdevpolarimeter, Packet_A, oncsSubevent, Packet_cdevdvm, Packet_cdevbpm, Packet_cdevwcm, and oncsSub_iddrs4v1.
|
pure virtual |
this supports devices which are inherently organized as two-dimensional data, such as flash ADC's (channel vs time slice)
Implemented in Packet_A, oncsSubevent, Packet_cdevwcm, and oncsSub_iddrs4v1.
|
pure virtual |
set a new packet identifier
Implemented in Packet_A, and oncsSubevent.
|
pure virtual |
Implemented in Packet_A, oncsSubevent, Packet_hbd_fpga, and Packet_hbd_fpgashort.