List of all members | Public Types | Public Member Functions | Private Types
cevt::CEvent Class Reference

Interface class to access to the SD part of an event. More...

#include <cevt/CEvent.h>

Public Types

typedef boost::filter_iterator
< CandidateStationFilter,
StationIterator
CandidateStationIterator
 Iterator over candidate stations. More...
 
typedef boost::filter_iterator
< CandidateStationFilter,
ConstStationIterator
ConstCandidateStationIterator
 
typedef boost::filter_iterator
< RejectedStationFilter,
ConstStationIterator
ConstRejectedStationIterator
 
typedef boost::filter_iterator
< SilentStationFilter,
ConstStationIterator
ConstSilentStationIterator
 
typedef
boost::indirect_iterator
< InternalConstStationIterator,
const Station & > 
ConstStationIterator
 
typedef boost::filter_iterator
< RejectedStationFilter,
StationIterator
RejectedStationIterator
 Iterator over rejected stations that match some rejection mask. More...
 
typedef boost::filter_iterator
< SilentStationFilter,
StationIterator
SilentStationIterator
 Iterator over silent stations. More...
 
typedef
boost::indirect_iterator
< InternalStationIterator,
Station & > 
StationIterator
 Iterator over all stations. More...
 

Public Member Functions

CandidateStationIterator CandidateStationsBegin ()
 
ConstCandidateStationIterator CandidateStationsBegin () const
 
CandidateStationIterator CandidateStationsEnd ()
 
ConstCandidateStationIterator CandidateStationsEnd () const
 
 CEvent (const CEvent &cEvent)
 
int GetNumberOfStations () const
 Get total number of stations in the event. More...
 
StationGetStation (const int stationId)
 retrieve station by id throw utl::NonExistentComponentException if n.a. More...
 
const StationGetStation (const int stationId) const
 
bool HasStation (const int stationId) const
 Check whether station exists. More...
 
void MakeStation (const int stationId)
 make a station with specifying Id, throw if invalid stationId More...
 
CEventoperator= (const CEvent &cEvent)
 
RejectedStationIterator RejectedStationsBegin (const int rejectionMask=~0)
 
ConstRejectedStationIterator RejectedStationsBegin (const int rejectionMask=~0) const
 
RejectedStationIterator RejectedStationsEnd (const int rejectionMask=~0)
 
ConstRejectedStationIterator RejectedStationsEnd (const int rejectionMask=~0) const
 
SilentStationIterator SilentStationsBegin ()
 
ConstSilentStationIterator SilentStationsBegin () const
 
SilentStationIterator SilentStationsEnd ()
 
ConstSilentStationIterator SilentStationsEnd () const
 
template<class OrderingCriterion >
void SortStations (const OrderingCriterion ord)
 Sort the list of stations by the criterion specified in an OrderingCriterion object. More...
 
StationIterator StationsBegin ()
 Beginning of all stations. More...
 
ConstStationIterator StationsBegin () const
 Beginning of all const stations. More...
 
StationIterator StationsEnd ()
 End of all stations. More...
 
ConstStationIterator StationsEnd () const
 End of all const stations. More...
 

Private Types

typedef
InternalStationCollection::const_iterator 
InternalConstStationIterator
 
typedef std::vector< Station * > InternalStationCollection
 
typedef
InternalStationCollection::iterator 
InternalStationIterator
 

Has/Make/Get methods

InternalStationCollection fStations
 
utl::LameShadowPtr< CEventSimDatafSimData
 
class evt::Event
 
class utl::LameShadowPtr< CEvent >
 
CEventSimDataGetSimData ()
 Get simulated data at event level. More...
 
const CEventSimDataGetSimData () const
 
void MakeSimData ()
 Make event simulated data object. More...
 
bool HasSimData () const
 Check whether event simulated data exists. More...
 
 CEvent ()
 
 ~CEvent ()
 
StationIterator RemoveStation (const StationIterator it)
 remove a station from the list More...
 

Detailed Description

Interface class to access to the SD part of an event.

Author
Stefano Argiro'
Date
28 january 2003

Definition at line 46 of file CEvent.h.

Member Typedef Documentation

Iterator over candidate stations.

Definition at line 80 of file CEvent.h.

Definition at line 82 of file CEvent.h.

Definition at line 114 of file CEvent.h.

Definition at line 98 of file CEvent.h.

typedef boost::indirect_iterator<InternalConstStationIterator, const Station&> cevt::CEvent::ConstStationIterator

Definition at line 61 of file CEvent.h.

typedef InternalStationCollection::const_iterator cevt::CEvent::InternalConstStationIterator
private

Definition at line 51 of file CEvent.h.

typedef std::vector<Station*> cevt::CEvent::InternalStationCollection
private

Definition at line 49 of file CEvent.h.

typedef InternalStationCollection::iterator cevt::CEvent::InternalStationIterator
private

Definition at line 50 of file CEvent.h.

Iterator over rejected stations that match some rejection mask.

Definition at line 112 of file CEvent.h.

Iterator over silent stations.

Definition at line 96 of file CEvent.h.

typedef boost::indirect_iterator<InternalStationIterator, Station&> cevt::CEvent::StationIterator

Iterator over all stations.

Definition at line 59 of file CEvent.h.

Constructor & Destructor Documentation

CEvent::CEvent ( const CEvent cEvent)

Definition at line 30 of file CEvent.cc.

CEvent::CEvent ( )
private

Definition at line 25 of file CEvent.cc.

CEvent::~CEvent ( )
private

Definition at line 36 of file CEvent.cc.

Member Function Documentation

CandidateStationIterator cevt::CEvent::CandidateStationsBegin ( )
inline

Definition at line 84 of file CEvent.h.

References StationsBegin(), and StationsEnd().

ConstCandidateStationIterator cevt::CEvent::CandidateStationsBegin ( ) const
inline

Definition at line 89 of file CEvent.h.

References StationsBegin(), and StationsEnd().

CandidateStationIterator cevt::CEvent::CandidateStationsEnd ( )
inline

Definition at line 86 of file CEvent.h.

References StationsEnd().

ConstCandidateStationIterator cevt::CEvent::CandidateStationsEnd ( ) const
inline

Definition at line 91 of file CEvent.h.

References StationsEnd().

int cevt::CEvent::GetNumberOfStations ( ) const
inline

Get total number of stations in the event.

Definition at line 137 of file CEvent.h.

References fStations.

CEventSimData& cevt::CEvent::GetSimData ( )
inline

Get simulated data at event level.

Definition at line 178 of file CEvent.h.

Referenced by io::CEvent_ROOT::CEvent_ROOT(), and io::CEvent_ROOT::operator>>().

const CEventSimData& cevt::CEvent::GetSimData ( ) const
inline

Definition at line 179 of file CEvent.h.

References fSimData.

Station & CEvent::GetStation ( const int  stationId)
const Station & CEvent::GetStation ( const int  stationId) const

Definition at line 83 of file CEvent.cc.

References ERROR.

bool cevt::CEvent::HasSimData ( ) const
inline

Check whether event simulated data exists.

Definition at line 183 of file CEvent.h.

References fSimData.

Referenced by io::CEvent_ROOT::CEvent_ROOT(), and io::CEvent_ROOT::operator>>().

bool CEvent::HasStation ( const int  stationId) const

Check whether station exists.

Definition at line 115 of file CEvent.cc.

Referenced by G4StationSimulatorOG::G4StationSimulator::RunFast(), and G4StationSimulatorOG::G4StationSimulator::RunFull().

void CEvent::MakeSimData ( )

Make event simulated data object.

Definition at line 191 of file CEvent.cc.

References ERROR.

Referenced by io::CEvent_ROOT::operator>>().

void CEvent::MakeStation ( const int  stationId)

make a station with specifying Id, throw if invalid stationId

Definition at line 99 of file CEvent.cc.

References WARNING.

Referenced by io::CEvent_ROOT::operator>>(), G4StationSimulatorOG::G4StationSimulator::RunFast(), and G4StationSimulatorOG::G4StationSimulator::RunFull().

CEvent & CEvent::operator= ( const CEvent cEvent)

Definition at line 45 of file CEvent.cc.

References StationsBegin(), and StationsEnd().

RejectedStationIterator cevt::CEvent::RejectedStationsBegin ( const int  rejectionMask = ~0)
inline

Definition at line 117 of file CEvent.h.

References StationsBegin(), and StationsEnd().

ConstRejectedStationIterator cevt::CEvent::RejectedStationsBegin ( const int  rejectionMask = ~0) const
inline

Definition at line 122 of file CEvent.h.

References StationsBegin(), and StationsEnd().

RejectedStationIterator cevt::CEvent::RejectedStationsEnd ( const int  rejectionMask = ~0)
inline

Definition at line 119 of file CEvent.h.

References StationsEnd().

ConstRejectedStationIterator cevt::CEvent::RejectedStationsEnd ( const int  rejectionMask = ~0) const
inline

Definition at line 124 of file CEvent.h.

References StationsEnd().

CEvent::StationIterator CEvent::RemoveStation ( const StationIterator  it)
private

remove a station from the list

Note
the same caveats of STL removal apply. The right way to remove stations is
for (StationIterator it = cevent.StationsBegin();
it != cevent.StationsEnd(); )
if (condition ...)
it = cevent.RemoveStation(it);
else
++it;
Note that removal of stations from the event is strongly discouraged!

Definition at line 128 of file CEvent.cc.

SilentStationIterator cevt::CEvent::SilentStationsBegin ( )
inline

Definition at line 100 of file CEvent.h.

References StationsBegin(), and StationsEnd().

ConstSilentStationIterator cevt::CEvent::SilentStationsBegin ( ) const
inline

Definition at line 105 of file CEvent.h.

References StationsBegin(), and StationsEnd().

SilentStationIterator cevt::CEvent::SilentStationsEnd ( )
inline

Definition at line 102 of file CEvent.h.

References StationsEnd().

ConstSilentStationIterator cevt::CEvent::SilentStationsEnd ( ) const
inline

Definition at line 107 of file CEvent.h.

References StationsEnd().

template<class OrderingCriterion >
void cevt::CEvent::SortStations ( const OrderingCriterion  ord)
inline

Sort the list of stations by the criterion specified in an OrderingCriterion object.

The OrderingCriterion class has to be specified in accordance with the STL strict weak ordering model http://www.sgi.com/tech/stl/StrictWeakOrdering.html

Predifined ordering are available in SortCriteria.h (see cevt::ByIncreasingSignal)

Example:

CEvent::SortStations(cevt::ByIncreasingSignal())

Definition at line 167 of file CEvent.h.

References fStations.

StationIterator cevt::CEvent::StationsBegin ( )
inline
ConstStationIterator cevt::CEvent::StationsBegin ( ) const
inline

Beginning of all const stations.

Definition at line 71 of file CEvent.h.

References fStations.

StationIterator cevt::CEvent::StationsEnd ( )
inline
ConstStationIterator cevt::CEvent::StationsEnd ( ) const
inline

End of all const stations.

Definition at line 74 of file CEvent.h.

References fStations.

Friends And Related Function Documentation

friend class evt::Event
friend

Definition at line 213 of file CEvent.h.

friend class utl::LameShadowPtr< CEvent >
friend

Definition at line 214 of file CEvent.h.

Member Data Documentation

utl::LameShadowPtr<CEventSimData> cevt::CEvent::fSimData
private

Definition at line 212 of file CEvent.h.

Referenced by GetSimData(), and HasSimData().

InternalStationCollection cevt::CEvent::fStations
private

Definition at line 206 of file CEvent.h.

Referenced by GetNumberOfStations(), SortStations(), StationsBegin(), and StationsEnd().


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

, generated on Tue Sep 26 2023.