Belle II Software  release-06-01-15
EventExtraInfo Class Reference

Class to stores ExtraInfo of the whole event. More...

#include <EventExtraInfo.h>

Inheritance diagram for EventExtraInfo:
Collaboration diagram for EventExtraInfo:

Public Member Functions

float getExtraInfo (const std::string &name) const
 Return given value if set. More...
 
bool hasExtraInfo (const std::string &name) const
 Return whether the extra info with the given name is set.
 
void removeExtraInfo ()
 Removes extra info from event.
 
void addExtraInfo (const std::string &name, float value)
 Sets the user-defined data of given name to the given value. More...
 
void setExtraInfo (const std::string &name, float value)
 Sets the user-defined data of given name to the given value. More...
 
std::string getInfoHTML () const
 Return a short summary of this object's contents in HTML format.
 
std::vector< std::string > getNames () const
 Grab the names in this event extra info (for printing etc)
 

Private Member Functions

 ClassDef (EventExtraInfo, 2)
 Class to store event extra info.
 

Private Attributes

std::map< std::string, float > eventExtraInfo
 map variable names to values.
 

Detailed Description

Class to stores ExtraInfo of the whole event.

Used by TMVAExpert to save expert output for a event-level training

Definition at line 25 of file EventExtraInfo.h.

Member Function Documentation

◆ addExtraInfo()

void addExtraInfo ( const std::string &  name,
float  value 
)

Sets the user-defined data of given name to the given value.

throws std::out_of_range if variable is already set.

Definition at line 32 of file EventExtraInfo.cc.

33 {
34  if (hasExtraInfo(name)) {
35  throw std::out_of_range(std::string("Key with name ") + name + " already exists in EventExtraInfo.");
36  }
37  eventExtraInfo[name] = value;
38 }
std::map< std::string, float > eventExtraInfo
map variable names to values.
bool hasExtraInfo(const std::string &name) const
Return whether the extra info with the given name is set.

◆ getExtraInfo()

float getExtraInfo ( const std::string &  name) const

Return given value if set.

throws std::out_of_range if variable is not set.

Definition at line 16 of file EventExtraInfo.cc.

◆ setExtraInfo()

void setExtraInfo ( const std::string &  name,
float  value 
)

Sets the user-defined data of given name to the given value.

Does not throw anything if the value is already set. Overrides existing values

Definition at line 40 of file EventExtraInfo.cc.


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