#include <Hdf5EventId.h>
Inheritance diagram for PSHdf5Input::Hdf5EventId:
Public Member Functions | |
Hdf5EventId (int run, const PSTime::Time &time, unsigned fiducials, unsigned ticks, unsigned vector, unsigned control) | |
virtual | ~Hdf5EventId () |
virtual PSTime::Time | time () const |
Return the time for event. | |
virtual int | run () const |
Return the run number for event. | |
virtual unsigned | fiducials () const |
Returns fiducials counter for the event. | |
virtual unsigned | ticks () const |
Returns 119MHz counter within the fiducial. | |
virtual unsigned | vector () const |
Returns event counter since Configure. | |
virtual unsigned | control () const |
Returns alternative bit representation for Xtc headers. | |
virtual bool | operator== (const EventId &other) const |
check if two event IDs refer to the same event | |
virtual bool | operator< (const EventId &other) const |
Compare two event IDs for ordering purpose. | |
virtual void | print (std::ostream &os) const |
Dump object in human-readable format. |
This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.
Definition at line 52 of file Hdf5EventId.h.
PSHdf5Input::Hdf5EventId::Hdf5EventId | ( | int | run, | |
const PSTime::Time & | time, | |||
unsigned | fiducials, | |||
unsigned | ticks, | |||
unsigned | vector, | |||
unsigned | control | |||
) | [inline] |
Definition at line 55 of file Hdf5EventId.h.
PSHdf5Input::Hdf5EventId::~Hdf5EventId | ( | ) | [virtual] |
Definition at line 39 of file Hdf5EventId.cpp.
unsigned PSHdf5Input::Hdf5EventId::control | ( | ) | const [virtual] |
Returns alternative bit representation for Xtc headers.
Is 0 if unknown
Implements PSEvt::EventId.
Definition at line 86 of file Hdf5EventId.cpp.
unsigned PSHdf5Input::Hdf5EventId::fiducials | ( | ) | const [virtual] |
Returns fiducials counter for the event.
Note that MCC sends fiducials as 17-bit number which overflows frequently (fiducials clock runs at 360Hz) so this number is not unique. In some cases (e.g. when reading from old HDF5 files) fiducials is not know, 0 will be returned in this case.
Implements PSEvt::EventId.
Definition at line 65 of file Hdf5EventId.cpp.
bool PSHdf5Input::Hdf5EventId::operator< | ( | const EventId & | other | ) | const [virtual] |
bool PSHdf5Input::Hdf5EventId::operator== | ( | const EventId & | other | ) | const [virtual] |
void PSHdf5Input::Hdf5EventId::print | ( | std::ostream & | os | ) | const [virtual] |
Dump object in human-readable format.
Implements PSEvt::EventId.
Definition at line 107 of file Hdf5EventId.cpp.
int PSHdf5Input::Hdf5EventId::run | ( | ) | const [virtual] |
Return the run number for event.
If run number is not known -1 will be returned.
Implements PSEvt::EventId.
Definition at line 58 of file Hdf5EventId.cpp.
unsigned PSHdf5Input::Hdf5EventId::ticks | ( | ) | const [virtual] |
Returns 119MHz counter within the fiducial.
Returns the value of 119MHz counter within the fiducial for the event code which initiated the readout. In some cases (e.g. when reading from old HDF5 files) ticks are not know, 0 will be returned in this case.
Implements PSEvt::EventId.
Definition at line 72 of file Hdf5EventId.cpp.
PSTime::Time PSHdf5Input::Hdf5EventId::time | ( | ) | const [virtual] |
Return the time for event.
Implements PSEvt::EventId.
Definition at line 47 of file Hdf5EventId.cpp.
unsigned PSHdf5Input::Hdf5EventId::vector | ( | ) | const [virtual] |
Returns event counter since Configure.
Note that counter is saved as 15-bits integer and will overflow frequently. In some cases (e.g. when reading from old HDF5 files) counter is not know, 0 will be returned in this case.
Implements PSEvt::EventId.
Definition at line 79 of file Hdf5EventId.cpp.