fire v0.19.0
Framework for sImulation and Reconstruction of Events
framework::Event Class Reference

Wrapper Event in this namespace reintroducing legacy functionality. More...

#include <EventProcessor.h>

Collaboration diagram for framework::Event:
[legend]

Public Member Functions

 Event (fire::Event &e)
 wrap the current event with a legacy interface
 
fire::EventHeadergetEventHeader ()
 Get the event header. More...
 
int getEventNumber () const
 Get the event number. More...
 
double getEventWeight () const
 Get the event weight. More...
 
template<typename T >
void add (const std::string &n, const T &o)
 Add an object to the event bus. More...
 
template<typename T >
const T & getObject (const std::string &n, const std::string &p="") const
 Retrieve an object from the event bus. More...
 
template<typename T >
const std::vector< T > & getCollection (const std::string &n, const std::string &p="") const
 Retrieve an object from the event bus. More...
 
template<typename K , typename V >
const std::map< K, V > & getCollection (const std::string &n, const std::string &p="") const
 Retrieve an object from the event bus. More...
 

Private Attributes

fire::Eventevent_
 reference to current event bus
 

Detailed Description

Wrapper Event in this namespace reintroducing legacy functionality.

This class is a light wrapper class merely providing function handles for the legacy interface with the event bus.

Deprecated:
This class is meant to be used only in the transitory phase where legacy processors are still supported. This class will be dropped when legacy processors are dropped.

Member Function Documentation

◆ add()

template<typename T >
void framework::Event::add ( const std::string n,
const T &  o 
)
inline

Add an object to the event bus.

See also
fire::Event::add

◆ getCollection() [1/2]

template<typename T >
const std::vector< T > & framework::Event::getCollection ( const std::string n,
const std::string p = "" 
) const
inline

Retrieve an object from the event bus.

See also
fire::Event::get

◆ getCollection() [2/2]

template<typename K , typename V >
const std::map< K, V > & framework::Event::getCollection ( const std::string n,
const std::string p = "" 
) const
inline

Retrieve an object from the event bus.

See also
fire::Event::get

◆ getEventHeader()

fire::EventHeader & framework::Event::getEventHeader ( )
inline

Get the event header.

Returns
event header

◆ getEventNumber()

int framework::Event::getEventNumber ( ) const
inline

Get the event number.

Returns
event number

◆ getEventWeight()

double framework::Event::getEventWeight ( ) const
inline

Get the event weight.

Returns
event weight

◆ getObject()

template<typename T >
const T & framework::Event::getObject ( const std::string n,
const std::string p = "" 
) const
inline

Retrieve an object from the event bus.

See also
fire::Event::get

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