XtcInput::Dgram Class Reference

Wrapper for Pds::Dgram class. More...

#include <Dgram.h>

Inheritance diagram for XtcInput::Dgram:

XtcInput::StreamDgram List of all members.

Public Types

typedef boost::shared_ptr<
Pds::Dgram > 
ptr

Public Member Functions

 Dgram (const ptr &dg, XtcFileName file, off64_t offset=-1)
 Dgram ()
ptr dg () const
 Return pointer to the datagream.
const XtcFileNamefile () const
 Return file name.
bool empty () const
bool operator< (const Dgram &) const
 compare clockTime's
off64_t offset () const
 dgram position in file, or -1 if no position information

Static Public Member Functions

static ptr make_ptr (Pds::Dgram *dg)
 Factory method which wraps existing object into a smart pointer.
static std::string dumpStr (const XtcInput::Dgram &dg)
 dump dgram header and filename to a string

Detailed Description

Wrapper for Pds::Dgram class.

This class wraps Pds::Datagram class and also adds some additional context information to it such as file name and position.

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

Version:
Id
Dgram.h 8788 2014-08-08 19:26:16Z davidsch@SLAC.STANFORD.EDU
Author:
Andrei Salnikov

Definition at line 52 of file Dgram.h.


Member Typedef Documentation

typedef boost::shared_ptr<Pds::Dgram> XtcInput::Dgram::ptr

Definition at line 55 of file Dgram.h.


Constructor & Destructor Documentation

XtcInput::Dgram::Dgram ( const ptr dg,
XtcFileName  file,
off64_t  offset = -1 
) [inline]

Constructor takes a smart pointer to XTC datagram object, the file name where datagram has originated, and optionally the offset within the file

Definition at line 66 of file Dgram.h.

XtcInput::Dgram::Dgram (  )  [inline]

Default ctor

Definition at line 71 of file Dgram.h.


Member Function Documentation

ptr XtcInput::Dgram::dg (  )  const [inline]

Return pointer to the datagream.

Definition at line 74 of file Dgram.h.

Referenced by XtcInput::allDgsHaveSameTransition(), PSXtcMPInput::XtcMPMasterInputBase::beginJob(), PSXtcInput::XtcInputModuleBase::beginJob(), clockTimesMatch(), XtcInput::StreamDgramGreater::doClockGreater(), XtcInput::StreamDgramGreater::doFidGreater(), XtcInput::StreamDgram::dumpStr(), dumpStr(), epicsOnly(), PSXtcMPInput::XtcMPMasterInputBase::event(), PSXtcInput::XtcInputModuleBase::event(), PSXtcInput::DgramSourceFile::fiducialSecondsMatch(), PSXtcInput::XtcInputModuleBase::fillEnv(), PSXtcInput::XtcInputModuleBase::fillEvent(), PSXtcInput::XtcInputModuleBase::fillEventId(), XtcInput::StreamDgramGreater::getDgramCategory(), XtcInput::XtcStreamMerger::getNextBlock(), isConfigOrBeginCalib(), isDisable(), isL1Accept(), XtcInput::l3tAcceptPass(), XtcInput::XtcStreamMerger::makeTransBlock(), PSXtcMPInput::XtcMPMasterInputBase::memorizeEpics(), XtcInput::XtcStreamMerger::next(), XtcInput::XtcMergeIterator::next(), PSXtcMPInput::DgramSourceWorker::next(), XtcInput::DgramList::push_back(), PSXtcMPInput::XtcMPMasterInputBase::send(), PSXtcMPInput::XtcMPDgramSerializer::sendDg(), PSXtcMPInput::XtcMPDgramSerializer::serialize(), XtcInput::XtcReadAheadTest::test(), and transitionsMatch().

std::string XtcInput::Dgram::dumpStr ( const XtcInput::Dgram dg  )  [static]

dump dgram header and filename to a string

Definition at line 83 of file Dgram.cpp.

References dg(), ex_acqiris::env, PackageVersions::msg, and setup::name.

bool XtcInput::Dgram::empty (  )  const [inline]

Definition at line 79 of file Dgram.h.

Referenced by XtcInput::allDgsHaveSameTransition(), clockTimesMatch(), XtcInput::StreamDgramGreater::doBlockGreater(), XtcInput::StreamDgramGreater::doClockGreater(), XtcInput::StreamDgramGreater::doFidGreater(), PSXtcInput::DgramSourceFile::fiducialSecondsMatch(), XtcInput::StreamDgramGreater::getDgramCategory(), XtcInput::XtcStreamMerger::getNextBlock(), isConfigOrBeginCalib(), isDisable(), isFiducialMatchStream(), isL1Accept(), XtcInput::StreamDgram::L1Block(), XtcInput::XtcStreamMerger::makeTransBlock(), XtcInput::XtcStreamMerger::next(), PSXtcInput::DgramSourceFile::next(), PSShmemInput::DgramSourceShmem::next(), XtcInput::StreamDgramGreater::operator()(), operator<(), XtcInput::StreamDgramGreater::sameEvent(), and transitionsMatch().

const XtcFileName& XtcInput::Dgram::file (  )  const [inline]

Return file name.

Definition at line 77 of file Dgram.h.

Referenced by XtcInput::StreamDgramGreater::doBlockGreater(), PSXtcInput::XtcInputModuleBase::fillEnv(), PSXtcInput::XtcInputModuleBase::fillEvent(), PSXtcInput::XtcInputModuleBase::fillEventId(), XtcInput::XtcStreamMerger::getNextBlock(), isFiducialMatchStream(), XtcInput::l3tAcceptPass(), XtcInput::XtcStreamMerger::makeTransBlock(), XtcInput::XtcStreamMerger::next(), XtcInput::LessStream::operator()(), XtcInput::DgramList::push_back(), XtcInput::StreamDgramGreater::runLessGreater(), PSXtcMPInput::XtcMPDgramSerializer::sendDg(), and PSXtcMPInput::XtcMPDgramSerializer::serialize().

Dgram::ptr XtcInput::Dgram::make_ptr ( Pds::Dgram *  dg  )  [static]

Factory method which wraps existing object into a smart pointer.

Definition at line 50 of file Dgram.cpp.

Referenced by XtcInput::DgHeader::dgram(), and PSShmemInput::ShmemMonitorClient::processDgram().

off64_t XtcInput::Dgram::offset (  )  const [inline]

dgram position in file, or -1 if no position information

Definition at line 85 of file Dgram.h.

Referenced by XtcInput::DgramList::push_back().

bool XtcInput::Dgram::operator< ( const Dgram  )  const

compare clockTime's

Definition at line 71 of file Dgram.cpp.

References empty(), and m_dg.


The documentation for this class was generated from the following files:
Generated on 19 Dec 2016 for PSDMSoftware by  doxygen 1.4.7