Data frame. More...

#include <JDAQFrame.hh>

Inheritance diagram for KM3NETDAQ::JDAQFrame:

Public Types
typedef const JDAQHit *	const_iterator

typedef JDAQHit *	iterator

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

typedef std::reverse_iterator< iterator >	reverse_iterator

Public Member Functions
	JDAQFrame ()
	Default constructor. More...

	JDAQFrame (const JDAQFrame &frame)
	Copy constructor. More...

	JDAQFrame (JDAQFrame &&frame)
	Move constructor. More...

	JDAQFrame (const int number_of_hits, const JDAQHit *data)
	Constructor. More...

virtual	~JDAQFrame ()
	Destructor. More...

JDAQFrame &	operator= (const JDAQFrame &frame)
	Assignment operator. More...

void	clear ()
	Clear data. More...

const_iterator	begin () const

const_iterator	end () const

iterator	begin ()

iterator	end ()

const_reverse_iterator	rbegin () const

const_reverse_iterator	rend () const

reverse_iterator	rbegin ()

reverse_iterator	rend ()

bool	empty () const

int	size () const

const JDAQHit *	data () const

JDAQHit *	data ()

const JDAQHit &	operator[] (int index) const
	Get hit at given index. More...

JDAQFrameSubset	subset (const int i1, const int i2) const
	Get subset of data. More...

JDAQFrame &	add (const JDAQFrame &frame)
	Add data. More...

JDAQFrame &	add (const int number_of_hits, const JDAQHit *data)
	Add data. More...

void	swap (JDAQFrame &frame)
	Swap data. More...

	ClassDef (JDAQFrame, 1)

Public Attributes
int	numberOfHits

JDAQHit *	buffer

Protected Member Functions
void	resize (const int number_of_hits)
	Resize internal buffer. More...

Friends
size_t	getSizeof (const JDAQFrame &)
	Get size of object. More...

JReader &	operator>> (JReader &, JDAQFrame &)
	Read DAQ frame from input. More...

JWriter &	operator<< (JWriter &, const JDAQFrame &)
	Write DAQ frame to output. More...

Detailed Description

Data frame.

Definition at line 65 of file JDAQFrame.hh.

Member Typedef Documentation

◆ const_iterator

typedef const JDAQHit* KM3NETDAQ::JDAQFrame::const_iterator

Definition at line 69 of file JDAQFrame.hh.

◆ iterator

typedef JDAQHit* KM3NETDAQ::JDAQFrame::iterator

Definition at line 70 of file JDAQFrame.hh.

◆ const_reverse_iterator

typedef std::reverse_iterator<const_iterator> KM3NETDAQ::JDAQFrame::const_reverse_iterator

Definition at line 71 of file JDAQFrame.hh.

◆ reverse_iterator

typedef std::reverse_iterator<iterator> KM3NETDAQ::JDAQFrame::reverse_iterator

Definition at line 72 of file JDAQFrame.hh.

Constructor & Destructor Documentation

◆ JDAQFrame() [1/4]

KM3NETDAQ::JDAQFrame::JDAQFrame ( )

inline

Default constructor.

Definition at line 81 of file JDAQFrame.hh.

                 :
       numberOfHits(0),
       buffer(NULL)
     {}

◆ JDAQFrame() [2/4]

KM3NETDAQ::JDAQFrame::JDAQFrame ( const JDAQFrame & frame )

inline

Copy constructor.

Parameters

frame frame

Definition at line 92 of file JDAQFrame.hh.

                                       :
       numberOfHits(0),
       buffer(NULL)
     {
       add(frame);
     }

◆ JDAQFrame() [3/4]

KM3NETDAQ::JDAQFrame::JDAQFrame ( JDAQFrame && frame )

inline

Move constructor.

Parameters

frame frame

Definition at line 105 of file JDAQFrame.hh.

                                  :
       numberOfHits(frame.numberOfHits),
       buffer      (frame.buffer)
     {
       frame.numberOfHits = 0;
       frame.buffer       = NULL;
     }

◆ JDAQFrame() [4/4]

KM3NETDAQ::JDAQFrame::JDAQFrame	(	const int	number_of_hits,
		const JDAQHit *	data
	)

inline

Constructor.

Parameters

number_of_hits	number of hits
data	pointer to data

Definition at line 120 of file JDAQFrame.hh.

                                                              :
       numberOfHits(0),
       buffer(NULL)
     {
       add(number_of_hits, data);
     }

◆ ~JDAQFrame()

virtual KM3NETDAQ::JDAQFrame::~JDAQFrame ( )

inlinevirtual

Destructor.

Definition at line 131 of file JDAQFrame.hh.

     {
       clear();
     }

Member Function Documentation

◆ operator=()

JDAQFrame& KM3NETDAQ::JDAQFrame::operator= ( const JDAQFrame & frame )

inline

Assignment operator.

Parameters

frame frame

Returns: this frame

Definition at line 143 of file JDAQFrame.hh.

     {
       add(frame);
  
       return *this;
     }

◆ clear()

void KM3NETDAQ::JDAQFrame::clear ( )

inline

Clear data.

Definition at line 154 of file JDAQFrame.hh.

     {
       if (buffer != NULL) {
         free(buffer);
       }
  
       numberOfHits = 0;
       buffer       = NULL;
     }

◆ begin() [1/2]

const_iterator KM3NETDAQ::JDAQFrame::begin ( ) const

inline

Definition at line 165 of file JDAQFrame.hh.

165 { return buffer; }

◆ end() [1/2]

const_iterator KM3NETDAQ::JDAQFrame::end ( ) const

inline

Definition at line 166 of file JDAQFrame.hh.

166 { return buffer + numberOfHits; }

◆ begin() [2/2]

iterator KM3NETDAQ::JDAQFrame::begin ( )

inline

Definition at line 169 of file JDAQFrame.hh.

169 { return buffer; }

◆ end() [2/2]

iterator KM3NETDAQ::JDAQFrame::end ( )

inline

Definition at line 170 of file JDAQFrame.hh.

170 { return buffer + numberOfHits; }

◆ rbegin() [1/2]

const_reverse_iterator KM3NETDAQ::JDAQFrame::rbegin ( ) const

inline

Definition at line 173 of file JDAQFrame.hh.

173 { return const_reverse_iterator(end()); }

KM3NETDAQ::JDAQFrame::end

const_iterator end() const

Definition: JDAQFrame.hh:166

KM3NETDAQ::JDAQFrame::const_reverse_iterator

std::reverse_iterator< const_iterator > const_reverse_iterator

Definition: JDAQFrame.hh:71

◆ rend() [1/2]

const_reverse_iterator KM3NETDAQ::JDAQFrame::rend ( ) const

inline

Definition at line 174 of file JDAQFrame.hh.

174 { return const_reverse_iterator(begin()); }

KM3NETDAQ::JDAQFrame::begin

const_iterator begin() const

Definition: JDAQFrame.hh:165

◆ rbegin() [2/2]

reverse_iterator KM3NETDAQ::JDAQFrame::rbegin ( )

inline

Definition at line 177 of file JDAQFrame.hh.

177 { return reverse_iterator(end()); }

KM3NETDAQ::JDAQFrame::reverse_iterator

std::reverse_iterator< iterator > reverse_iterator

Definition: JDAQFrame.hh:72

◆ rend() [2/2]

reverse_iterator KM3NETDAQ::JDAQFrame::rend ( )

inline

Definition at line 178 of file JDAQFrame.hh.

178 { return reverse_iterator(begin()); }

◆ empty()

bool KM3NETDAQ::JDAQFrame::empty ( ) const

inline

Definition at line 181 of file JDAQFrame.hh.

181 { return numberOfHits == 0; }

◆ size()

int KM3NETDAQ::JDAQFrame::size ( ) const

inline

Definition at line 183 of file JDAQFrame.hh.

183 { return numberOfHits; }

◆ data() [1/2]

const JDAQHit* KM3NETDAQ::JDAQFrame::data ( ) const

inline

Definition at line 185 of file JDAQFrame.hh.

185 { return buffer; }

◆ data() [2/2]

JDAQHit* KM3NETDAQ::JDAQFrame::data ( )

inline

Definition at line 186 of file JDAQFrame.hh.

186 { return buffer; }

◆ operator[]()

const JDAQHit& KM3NETDAQ::JDAQFrame::operator[] ( int index ) const

inline

Get hit at given index.

Parameters

index index

Returns: hit

Definition at line 195 of file JDAQFrame.hh.

     {
       return buffer[index];
     }

◆ subset()

JDAQFrameSubset KM3NETDAQ::JDAQFrame::subset	(	const int	i1,
		const int	i2
	)		const

inline

Get subset of data.

Parameters

i1	first index of hit (included)
i2	last index of hit (excluded)

Returns: frame

Definition at line 207 of file JDAQFrame.hh.

     {
       return JDAQFrameSubset(i2 - i1, buffer + i1);
     }

◆ add() [1/2]

JDAQFrame& KM3NETDAQ::JDAQFrame::add ( const JDAQFrame & frame )

inline

Add data.

Parameters

frame frame

Returns: this frame

Definition at line 219 of file JDAQFrame.hh.

     {
       return add(frame.numberOfHits, frame.buffer);
     }

◆ add() [2/2]

JDAQFrame& KM3NETDAQ::JDAQFrame::add	(	const int	number_of_hits,
		const JDAQHit *	data
	)

inline

Add data.

Parameters

number_of_hits	number of hits
data	pointer to data

Returns: this data frame

Definition at line 232 of file JDAQFrame.hh.

     {
       if (number_of_hits > 0) {
  
         resize(numberOfHits + number_of_hits);
  
         memcpy(buffer + numberOfHits - number_of_hits, data, number_of_hits * sizeof(JDAQHit));
       }
  
       return *this;
     }

◆ swap()

void KM3NETDAQ::JDAQFrame::swap ( JDAQFrame & frame )

inline

Swap data.

Parameters

frame frame

Definition at line 250 of file JDAQFrame.hh.

     {
       std::swap(numberOfHits, frame.numberOfHits);
       std::swap(buffer,       frame.buffer);
     }

◆ ClassDef()

KM3NETDAQ::JDAQFrame::ClassDef	(	JDAQFrame	,
		1
	)

◆ resize()

void KM3NETDAQ::JDAQFrame::resize ( const int number_of_hits )

inlineprotected

Resize internal buffer.

This method increases the size of the buffer if necessary. Otherwise, the current size is maintained.

Parameters

number_of_hits total number of hits to allocate

Definition at line 273 of file JDAQFrame.hh.

     {
       if (number_of_hits > numberOfHits) {
  
         const int number_of_bytes = number_of_hits * sizeof(JDAQHit);
  
         if (buffer == NULL)
           buffer = (JDAQHit*) malloc(number_of_bytes);
         else
           buffer = (JDAQHit*) realloc(buffer, number_of_bytes);
  
         if (buffer == NULL) {
           throw JDAQException("JDAQFrame::resize(): Memory exception - number of hits = " + std::to_string(number_of_hits));
         }
  
         numberOfHits = number_of_hits;
       }
     }

Friends And Related Function Documentation

◆ getSizeof

size_t getSizeof ( const JDAQFrame & object )

friend

Get size of object.

Parameters

object DAQ frame

Returns: number of bytes

Definition at line 21 of file JDAQFrameIO.hh.

   {
     return sizeof(JDAQFrame::numberOfHits)  +  object.numberOfHits * sizeof(JDAQHit);
   }

◆ operator>>

JReader& operator>>	(	JReader &	in,
		JDAQFrame &	frame
	)

friend

Read DAQ frame from input.

Parameters

in	reader
frame	DAQ frame

Returns: reader

Definition at line 34 of file JDAQFrameIO.hh.

   {
     frame.clear();
  
     int number_of_hits;
  
     in >> number_of_hits; 
  
     frame.resize(number_of_hits);
  
     in.read((char*) frame.buffer, frame.numberOfHits * sizeof(JDAQHit));
  
     return in;
   }

◆ operator<<

JWriter& operator<<	(	JWriter &	out,
		const JDAQFrame &	frame
	)

friend

Write DAQ frame to output.

Parameters

out	writer
frame	DAQ frame

Returns: writer

Definition at line 57 of file JDAQFrameIO.hh.

   {
     out << frame.numberOfHits;
  
     out.write((char*) frame.buffer, frame.numberOfHits * sizeof(JDAQHit));
  
     return out;
   }

Member Data Documentation

◆ numberOfHits

int KM3NETDAQ::JDAQFrame::numberOfHits

Definition at line 257 of file JDAQFrame.hh.

◆ buffer

JDAQHit* KM3NETDAQ::JDAQFrame::buffer

Definition at line 258 of file JDAQFrame.hh.

The documentation for this class was generated from the following file:

JDAQFrame.hh

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ const_reverse_iterator

◆ reverse_iterator

Constructor & Destructor Documentation

◆ JDAQFrame() [1/4]

◆ JDAQFrame() [2/4]

◆ JDAQFrame() [3/4]

◆ JDAQFrame() [4/4]

◆ ~JDAQFrame()

Member Function Documentation

◆ operator=()

◆ clear()

◆ begin() [1/2]

◆ end() [1/2]

◆ begin() [2/2]

◆ end() [2/2]

◆ rbegin() [1/2]

◆ rend() [1/2]

◆ rbegin() [2/2]

◆ rend() [2/2]

◆ empty()

◆ size()

◆ data() [1/2]

◆ data() [2/2]

◆ operator[]()

◆ subset()

◆ add() [1/2]

◆ add() [2/2]

◆ swap()

◆ ClassDef()

◆ resize()

Friends And Related Function Documentation

◆ getSizeof

◆ operator>>

◆ operator<<

Member Data Documentation

◆ numberOfHits

◆ buffer