PSXtcInput::DgramSourceIndex Class Reference
[PSXtcInput package]

Implementation of IDatagramSource interface which reads data from input files. More...

#include <DgramSourceIndex.h>

Inheritance diagram for PSXtcInput::DgramSourceIndex:

List of all members.

Public Member Functions
	DgramSourceIndex ()
virtual	~DgramSourceIndex ()
virtual void	init ()
void	setQueue (std::queue< DgramPieces > &queue)
virtual bool	next (std::vector< XtcInput::Dgram > &eventDg, std::vector< XtcInput::Dgram > &nonEventDg)
	Return next datagram(s) from the source.

---

Detailed Description

Implementation of IDatagramSource interface which reads data from input files.

Note:

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

Version:

Id

DgramSourceIndex.h 7696 2014-02-27 00:40:59Z cpo@SLAC.STANFORD.EDU

Author:

Christopher O'Grady

Definition at line 54 of file DgramSourceIndex.h.

---

Constructor & Destructor Documentation

PSXtcInput::DgramSourceIndex::DgramSourceIndex

(

)

Definition at line 40 of file DgramSourceIndex.cpp.

PSXtcInput::DgramSourceIndex::~DgramSourceIndex

(

)

[virtual]

Definition at line 48 of file DgramSourceIndex.cpp.

---

Member Function Documentation

void PSXtcInput::DgramSourceIndex::init

(

)

[virtual]

Initialization method for datagram source, this is typically called in beginJob() method and it may contain initialization code which cannot be executed during construction of an instance.

Implements PSXtcInput::IDatagramSource.

Definition at line 53 of file DgramSourceIndex.cpp.

bool PSXtcInput::DgramSourceIndex::next	(	std::vector< XtcInput::Dgram > &	eventDg,
		std::vector< XtcInput::Dgram > &	nonEventDg
	)			[virtual]

Return next datagram(s) from the source.

This method returns two sets of datagrams - eventDg is the set of histograms belonging to the next event, nonEventDg is the set of datagrams which has some other data (like EPICS) which is needed for correct interpretation of current event. Currently eventDg should contain one datagram but potentially in the future we may start event building in offline and that list can grow longer. It nonEventDg is non-empty then it has to be processed first as those datagram should come from earlier time than eventDg and eventDg may contain data that overrides data in nonEventDg (e.g. some EPICS PV data may be contained in both nonEventDg and eventDg).

This method will called repeatedly until it returns false.

Parameters:

[out]	eventDg	returned set of datagrams for current event
[out]	nonEventDg	returned set of datagrams containing other information.

Returns:

false if there are no more events, both eventDg and nonEventDg will be empty in this case.

Implements PSXtcInput::IDatagramSource.

Definition at line 58 of file DgramSourceIndex.cpp.

void PSXtcInput::DgramSourceIndex::setQueue

(

std::queue< DgramPieces > &

queue

)

[inline]

Definition at line 60 of file DgramSourceIndex.h.

---

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

• PSXtcInput/include/DgramSourceIndex.h
• PSXtcInput/src/DgramSourceIndex.cpp

---