pmt_wf_collection Class Reference
[DataFormat, DataFormat]

Event-wise data member class to hold a collection of ch-wise data members. More...

#include <pmt_waveform.hh>

Inheritance diagram for pmt_wf_collection:


Public Member Functions
	pmt_wf_collection (size_t len=0)
	Default constructor ... provide an option to set the length of ch-wise data.
	pmt_wf_collection (const pmt_wf_collection &original)
	Default copy constructor needed to avoid memory leak in ROOT streamer.
	~pmt_wf_collection ()
	Default destructor.
void	set_event_id (PMT::word_t id)
	Setter for the envet id number.
void	set_event_frame_id (PMT::word_t id)
	Setter for the event frame number.
void	set_module_address (PMT::word_t id)
	Setter for the module address from which this event is read-out.
void	set_module_id (PMT::word_t id)
	Setter for the module ID.
void	set_channel_header_count (size_t n)
	Setter for the channel's header count.
void	set_checksum (PMT::word_t sum)
	Setter for the checksum.
void	set_nwords (PMT::word_t n)
	Setter for the # words read out.
void	set_trigger_frame_id (PMT::word_t id)
	Setter for the trigger frame id.
void	set_trigger_timeslice (PMT::word_t n)
	Setter for the trigger timeslice.
PMT::word_t	event_id () const
	Getter for the event ID.
PMT::word_t	event_frame_id () const
	Getter for the frame ID.
PMT::word_t	module_address () const
	Getter for the module address.
PMT::word_t	module_id () const
	Getter for the module ID.
size_t	channel_header_count () const
	Getter for the channel header count.
PMT::word_t	checksum () const
	Getter for the checksum.
PMT::word_t	nwords () const
	Getter for the number of read words.
PMT::word_t	trigger_frame_id () const
	Getter for the trigger frame id.
PMT::word_t	trigger_timeslice () const
	Getter for the trigger time slice.
virtual void	clear_data ()
	A function to reset data member variables.
Private Member Functions
void	init_vars ()
Private Attributes
PMT::word_t	_event_id
	Actual implementation function of resetting variables event ID number.
PMT::word_t	_event_frame_id
	event frame ID number
PMT::word_t	_module_address
	module address number
PMT::word_t	_module_id
	module ID number
size_t	_channel_header_count
	channel header count
PMT::word_t	_trigger_frame_id
	trigger frame id
PMT::word_t	_trigger_timeslice
	trigger time slice
PMT::word_t	_checksum
	checksum of readout events
PMT::word_t	_nwords
	# of event words readout

Detailed Description

Event-wise data member class to hold a collection of ch-wise data members.

Definition at line 104 of file pmt_waveform.hh.

Constructor & Destructor Documentation

pmt_wf_collection::pmt_wf_collection ( size_t len = 0 ) [inline]

Default constructor ... provide an option to set the length of ch-wise data.

Definition at line 110 of file pmt_waveform.hh.

00110                                     :
00111     std::vector<pmt_waveform>(len), 
00112     data_base()
00113   {};

pmt_wf_collection::pmt_wf_collection ( const pmt_wf_collection & original ) [inline]

Default copy constructor needed to avoid memory leak in ROOT streamer.

Definition at line 116 of file pmt_waveform.hh.

00117     : std::vector<pmt_waveform>(original),
00118       data_base(original),
00119       _event_id(original._event_id),
00120       _event_frame_id(original._event_frame_id),
00121       _module_address(original._module_address),
00122       _module_id(original._module_id),
00123       _channel_header_count(original._channel_header_count),
00124       _checksum(original._checksum),
00125       _nwords(original._nwords)
00126   {};

pmt_wf_collection::~pmt_wf_collection ( ) [inline]

Default destructor.

Definition at line 129 of file pmt_waveform.hh.

00129 {};

Member Function Documentation

size_t pmt_wf_collection::channel_header_count ( ) const [inline]

Getter for the channel header count.

Definition at line 171 of file pmt_waveform.hh.

References _channel_header_count.

00171 {return _channel_header_count;};

PMT::word_t pmt_wf_collection::checksum ( ) const [inline]

Getter for the checksum.

Definition at line 174 of file pmt_waveform.hh.

References _checksum.

Referenced by algo_slow_readout_decoder::decode_event_header(), and pmt_slow_encoder::encode_event_header().

00174 {return _checksum;};

void pmt_wf_collection::clear_data ( ) [virtual]

A function to reset data member variables.

Reimplemented from data_base.

Definition at line 19 of file pmt_waveform.cc.

References data_base::clear_data(), and init_vars().

Referenced by algo_pmt_xmit::clear_event().

00019                                   {
00020   data_base::clear_data();
00021   init_vars();
00022 }

PMT::word_t pmt_wf_collection::event_frame_id ( ) const [inline]

Getter for the frame ID.

Definition at line 162 of file pmt_waveform.hh.

References _event_frame_id.

Referenced by algo_slow_readout_decoder::decode_ch_word(), algo_pmt_xmit::decode_ch_word(), algo_slow_readout_decoder::decode_event_header(), and pmt_slow_encoder::encode_event_header().

00162 {return _event_frame_id;};

PMT::word_t pmt_wf_collection::event_id ( ) const [inline]

void pmt_wf_collection::init_vars ( ) [private]

Definition at line 24 of file pmt_waveform.cc.

References _channel_header_count, _checksum, _event_frame_id, _event_id, _module_address, _module_id, _nwords, _trigger_frame_id, _trigger_timeslice, and PMT::INVALID_WORD.

Referenced by clear_data().

00024                                  {
00025   clear();
00026   _event_id=PMT::INVALID_WORD;
00027   _event_frame_id=PMT::INVALID_WORD;
00028   _module_address=PMT::INVALID_WORD;
00029   _module_id=PMT::INVALID_WORD;
00030   _channel_header_count=PMT::INVALID_WORD;
00031   _checksum=PMT::INVALID_WORD;
00032   _nwords=PMT::INVALID_WORD;
00033   _trigger_frame_id=PMT::INVALID_WORD;
00034   _trigger_timeslice=PMT::INVALID_WORD;
00035 }