EVENT::LCEvent Class Reference

#include <LCEvent.h>

Inheritance diagram for EVENT::LCEvent:

List of all members.

Public Member Functions
virtual	~LCEvent ()
	Destructor.
virtual int	getRunNumber () const =0
virtual int	getEventNumber () const =0
virtual const std::string &	getDetectorName () const =0
virtual long64	getTimeStamp () const =0
virtual const std::vector< std::string > *	getCollectionNames () const =0
virtual LCCollection *	getCollection (const std::string &name) const =0 throw (DataNotAvailableException, std::exception )
virtual LCCollection *	takeCollection (const std::string &name) const =0 throw (DataNotAvailableException, std::exception )
virtual void	addCollection (LCCollection *col, const std::string &name)=0 throw (EventException, std::exception )
virtual void	removeCollection (const std::string &name)=0 throw (ReadOnlyException, std::exception )
virtual const LCParameters &	getParameters () const =0
virtual LCParameters &	parameters ()=0

---

Detailed Description

The main event interface. Holds named collections with elements of type LCObject ('untyped'). Users have to cast to the corresponding types.

Author:

gaede

Version:

Id

LCEvent.aid,v 1.12 2005/03/07 11:36:18 gaede Exp

See also:

LCCollection

Definition at line 30 of file LCEvent.h.

---

Constructor & Destructor Documentation

virtual EVENT::LCEvent::~LCEvent (   )  [inline, virtual]

Destructor. Definition at line 34 of file LCEvent.h.

---

Member Function Documentation

virtual void EVENT::LCEvent::addCollection (  LCCollection *  col, const std::string &  name )  throw (EventException, std::exception ) [pure virtual]

Adds a collection with the given name. Throws an exception if the name already exists in the event. NB: Adding collections is allowed even when the event is 'read only'. Exceptions: EventException  Referenced by tpc_tracking::Event::addCollection(), tpc_tracking::CustomLCIOCollection< lcio::MCParticle >::derived_write(), and marlin::SimpleFastMCProcessor::processEvent().

virtual LCCollection* EVENT::LCEvent::getCollection (  const std::string &  name  )  const throw (DataNotAvailableException, std::exception ) [pure virtual]

Returns the collection for the given name. Exceptions: DataNotAvailableException  Implemented in IMPL::LCEventImpl. Referenced by marlin::MarlinSteerCheck::addLCIOFile(), marlin::SimpleFastMCProcessor::check(), tpc_tracking::CustomLCIOCollection< lcio::MCParticle >::derived_write(), marlin::LCIOOutputProcessor::dropCollections(), UTIL::LCTOOLS::dumpEvent(), UTIL::LCTOOLS::dumpEventDetailed(), tpc_tracking::Event::getCollection(), tpc_tracking::Event::ls(), marlin::SimpleFastMCProcessor::processEvent(), tpc_tracking::CustomLCIOCollection< lcio::MCParticle >::read_collection(), SIO::SIOParticleHandler::restoreParentDaughterRelations(), SIO::SIOWriter::setUpHandlers(), and SIO::SIOEventHandler::xfer().

virtual const std::vector<std::string>* EVENT::LCEvent::getCollectionNames (   )  const [pure virtual]

Returns the names of the collections in the event. Implemented in IMPL::LCEventImpl. Referenced by marlin::MarlinSteerCheck::addLCIOFile(), marlin::LCIOOutputProcessor::dropCollections(), UTIL::LCTOOLS::dumpEvent(), UTIL::LCTOOLS::dumpEventDetailed(), tpc_tracking::Event::ls(), SIO::SIOParticleHandler::restoreParentDaughterRelations(), SIO::SIOWriter::setUpHandlers(), and SIO::SIOEventHandler::xfer().

virtual const std::string& EVENT::LCEvent::getDetectorName (   )  const [pure virtual]

Returns the name of the detector setup used in the simulation. Implemented in IMPL::LCEventImpl. Referenced by UTIL::LCTOOLS::dumpEventDetailed(), tpc_tracking::Event::ls(), and SIO::SIOEventHandler::xfer().

virtual int EVENT::LCEvent::getEventNumber (   )  const [pure virtual]

Returns this event's number . Implemented in IMPL::LCEventImpl. Referenced by marlin::TestProcessor::check(), UTIL::LCTOOLS::dumpEventDetailed(), tpc_tracking::Event::ls(), PutChargeOnPadsProcessor::processEvent(), marlin::TestProcessor::processEvent(), and SIO::SIOEventHandler::xfer().

virtual const LCParameters& EVENT::LCEvent::getParameters (   )  const [pure virtual]

Parameters defined for this event. Implemented in IMPL::LCEventImpl. Referenced by UTIL::LCTOOLS::dumpEventDetailed(), and SIO::SIOEventHandler::xfer().

virtual int EVENT::LCEvent::getRunNumber (   )  const [pure virtual]

Return the run number off this event. Implemented in IMPL::LCEventImpl. Referenced by marlin::TestProcessor::check(), UTIL::LCTOOLS::dumpEventDetailed(), tpc_tracking::Event::ls(), marlin::TestProcessor::processEvent(), and SIO::SIOEventHandler::xfer().

virtual long64 EVENT::LCEvent::getTimeStamp (   )  const [pure virtual]

Returns the time stamp of the event. Timestamp is a unique 64 bit integer. Definition: ns since January 1, 1970, 00:00:00 GMT Implemented in IMPL::LCEventImpl. Referenced by UTIL::LCTOOLS::dumpEventDetailed(), and SIO::SIOEventHandler::xfer().

virtual LCParameters& EVENT::LCEvent::parameters (   )  [pure virtual]

Parameters defined for this event. Implemented in IMPL::LCEventImpl.

virtual void EVENT::LCEvent::removeCollection (  const std::string &  name  )  throw (ReadOnlyException, std::exception ) [pure virtual]

Removes (and deletes) the collection with name (if it exists in the event). Throws an exception if the event is 'read only' as defined by the read mode in LCReader. Exceptions: ReadOnlyException  Implemented in IMPL::LCEventImpl. Referenced by tpc_tracking::CustomLCIOCollection< lcio::MCParticle >::derived_write().

virtual LCCollection* EVENT::LCEvent::takeCollection (  const std::string &  name  )  const throw (DataNotAvailableException, std::exception ) [pure virtual]

Returns the collection for the given name and transfers the ownership of the collection to the caller. The caller is responsible for deleting the collection _after_ the Event is deleted. The collection is still in the event but flagged as transient after the call returns. This is usefull when you want to keep the collection for the next events. Use with care! Exceptions: DataNotAvailableException  Implemented in IMPL::LCEventImpl.

---

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

• include/EVENT/LCEvent.h

---