LCIO  02.17
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
LCEvent.h
Go to the documentation of this file.
1 // -*- C++ -*-
2 // AID-GENERATED
3 // =========================================================================
4 // This class was generated by AID - Abstract Interface Definition
5 // DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
6 // =========================================================================
7 #ifndef EVENT_LCEVENT_H
8 #define EVENT_LCEVENT_H 1
9 
10 #include <string>
11 #include <vector>
12 
13 #include "EVENT/LCParameters.h"
14 #include "Exceptions.h"
15 #include "LCIOTypes.h"
16 #include "LCRTRelations.h"
17 
18 namespace EVENT {
19 
20 class LCCollection;
21 
31 class LCEvent {
32 
33 public:
35  virtual ~LCEvent() { /* nop */; }
36 
39  virtual int getRunNumber() const = 0;
40 
43  virtual int getEventNumber() const = 0;
44 
47  virtual const std::string & getDetectorName() const = 0;
48 
53  virtual long64 getTimeStamp() const = 0;
54 
57  virtual double getWeight() const = 0;
58 
61  virtual const std::vector<std::string> * getCollectionNames() const = 0;
62 
67  virtual LCCollection * getCollection(const std::string & name) const = 0;
68 
77  virtual LCCollection * takeCollection(const std::string & name) const = 0;
78 
86  virtual void addCollection(LCCollection * col, const std::string & name) = 0;
87 
93  virtual void removeCollection(const std::string & name) = 0;
94 
97  virtual const LCParameters & getParameters() const = 0;
98 
101  virtual LCParameters & parameters() = 0;
102 
105  virtual lcrtrel::LCRTRelations & runtime() = 0;
106 
107 // //fg20040528: added relations to the event
108 // /** Returns the names of the relations in the event.
109 // */
110 // public const String[]* getRelationNames() const ;
111 // /** Returns the relation for the given name.
112 // *
113 // * @throws DataNotAvailableException
114 // */
115 // public LCRelation* getRelation(const String& name) const throws DataNotAvailableException ;
116 // /** Adds a relation with the given name. Throws an exception if the name already
117 // * exists in the event. NB: Adding relations is allowed even when the event is 'read only'.
118 // *
119 // *@throws EventException
120 // */
121 // public void addRelation(LCRelation* col ,const String& name ) throws EventException ;
122 // /** Removes (and deletes) the relation with name (if it exists in the event).
123 // * Throws an exception if the event is 'read only' as defined by the read mode in LCReader.
124 // *
125 // *@throws ReadOnlyException
126 // */
127 // public void removeRelation(const String& name ) throws ReadOnlyException ;
128 }; // class
129 } // namespace EVENT
130 #endif /* ifndef EVENT_LCEVENT_H */
virtual const LCParameters & getParameters() const =0
Parameters defined for this event.
virtual double getWeight() const =0
Returns the event weight.
virtual LCCollection * takeCollection(const std::string &name) const =0
Returns the collection for the given name and transfers the ownership of the collection to the caller...
virtual int getRunNumber() const =0
Return the run number off this event.
virtual const std::vector< std::string > * getCollectionNames() const =0
Returns the names of the collections in the event.
virtual long64 getTimeStamp() const =0
Returns the time stamp of the event.
Base class that provides run time (user) extensions and relation between objects. ...
long long long64
64 bit signed integer,e.g.to be used for timestamps
Definition: LCIOTypes.h:14
STL class.
virtual LCParameters & parameters()=0
Parameters defined for this event.
virtual lcrtrel::LCRTRelations & runtime()=0
Get the runtime extensions for this event.
virtual LCCollection * getCollection(const std::string &name) const =0
Returns the collection for the given name.
Simple interface to store generic named parameters of type int, float and string. ...
Definition: LCParameters.h:28
virtual const std::string & getDetectorName() const =0
Returns the name of the detector setup used in the simulation.
virtual void removeCollection(const std::string &name)=0
Removes (and deletes) the collection with name (if it exists in the event).
The main event interface.
Definition: LCEvent.h:31
The generic collection used in LCIO.
Definition: LCCollection.h:29
virtual int getEventNumber() const =0
Returns this event&#39;s number .
virtual void addCollection(LCCollection *col, const std::string &name)=0
Adds a collection with the given name (has to be a valid C/C++ variable name).
virtual ~LCEvent()
Destructor.
Definition: LCEvent.h:35