GFrameDataCollection Class Reference

#include <gFrameDataCollection.h>

Collaboration diagram for GFrameDataCollection:

Public Member Functions
	GFrameDataCollection (GFrameHeader *header, std::shared_ptr< GLogger > logger)
	Constructs a GFrameDataCollection.
	~GFrameDataCollection ()
	Destructor for GFrameDataCollection.
void	addIntegralPayload (std::vector< int > payload) const
	Adds an integral payload.
void	addEvent (int evn)
bool	shouldWriteFrame () const
const GFrameHeader *	getHeader () const
	Gets the frame header.
const std::vector< GIntegralPayload * > *	getIntegralPayload () const
	Gets the integral payloads.
long int	getFrameID () const
	Gets the frame ID.

Detailed Description

Definition at line 15 of file gFrameDataCollection.h.

Constructor & Destructor Documentation

GFrameDataCollection()

GFrameDataCollection::GFrameDataCollection ( GFrameHeader * header, std::shared_ptr< GLogger > logger )

inline

Parameters

header	Pointer to a GFrameDataCollectionHeader.
logger	Pointer to a GLogger instance.

Definition at line 22 of file gFrameDataCollection.h.

~GFrameDataCollection()

GFrameDataCollection::~GFrameDataCollection ( )

inline

Definition at line 31 of file gFrameDataCollection.h.

Member Function Documentation

addEvent()

void GFrameDataCollection::addEvent

(

int

evn

)

addIntegralPayload()

void GFrameDataCollection::addIntegralPayload ( std::vector< int > payload ) const

inline

Expects the payload vector to have exactly 5 elements: crate, slot, channel, charge, and time.

Parameters

payload

A vector of integers representing the payload.

Definition at line 47 of file gFrameDataCollection.h.

getFrameID()

long int GFrameDataCollection::getFrameID ( ) const

inline

Returns

The frame ID.

Definition at line 86 of file gFrameDataCollection.h.

getHeader()

const GFrameHeader * GFrameDataCollection::getHeader ( ) const

inline

Returns

Pointer to the frame header.

Definition at line 74 of file gFrameDataCollection.h.

getIntegralPayload()

const std::vector< GIntegralPayload * > * GFrameDataCollection::getIntegralPayload ( ) const

inline

Returns

Pointer to a vector of GIntegralPayload pointers.

Definition at line 80 of file gFrameDataCollection.h.

shouldWriteFrame()

bool GFrameDataCollection::shouldWriteFrame

(

)

const

---

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

• frame/gFrameDataCollection.h