PhysicsTools::Variable Class Reference

Class describing an input variable. More...

#include <Variable.h>

Classes
class	Value
	Helper class that can contain an identifier-value pair. More...
class	ValueList
	Helper class that can contain an list of identifier-value pairs. More...

Public Types
enum	Flags { FLAG_NONE = 0, FLAG_OPTIONAL = 1 << 0, FLAG_MULTIPLE = 1 << 1, FLAG_ALL = (1 << 2) - 1 }

Public Member Functions
Flags	getFlags () const
const AtomicId	getName () const
bool	isMultiple () const
bool	isOptional () const
	Variable ()
	Variable (const Variable &orig)
	Variable (AtomicId name, Flags flags=FLAG_NONE)

Private Attributes
Flags	flags
AtomicId	name

Detailed Description

Class describing an input variable.

The class Variable describes an input variable by its name and properties. The name is represented by an atomic identifier (an alphanumerical value). The properties consists of flags. Currently the two flags describe the allowed number of times a variable can appear in the input, whether a variable is allowed to be omitted and whether a variable can have multiple values.

Definition at line 33 of file Variable.h.

Member Enumeration Documentation

Flags

enum PhysicsTools::Variable::Flags

Enumerator
FLAG_NONE
FLAG_OPTIONAL
FLAG_MULTIPLE
FLAG_ALL

Definition at line 35 of file Variable.h.

{ FLAG_NONE = 0, FLAG_OPTIONAL = 1 << 0, FLAG_MULTIPLE = 1 << 1, FLAG_ALL = (1 << 2) - 1 };

Constructor & Destructor Documentation

Variable() [1/3]

PhysicsTools::Variable::Variable ( )

inline

Definition at line 132 of file Variable.h.

{}

Variable() [2/3]

PhysicsTools::Variable::Variable ( const Variable &  orig )

inline

Definition at line 133 of file Variable.h.

: name(orig.name), flags(orig.flags) {}

Variable() [3/3]

PhysicsTools::Variable::Variable ( AtomicId  name, Flags  flags = FLAG_NONE  )

inline

Definition at line 134 of file Variable.h.

: name(name), flags(flags) {}

Member Function Documentation

getFlags()

Flags PhysicsTools::Variable::getFlags ( ) const

inline

Definition at line 137 of file Variable.h.

References flags.

{ return flags; }

getName()

const AtomicId PhysicsTools::Variable::getName ( void  ) const

inline

Definition at line 136 of file Variable.h.

References name.

Referenced by plotting.Plot::draw().

{ return name; }

isMultiple()

bool PhysicsTools::Variable::isMultiple ( ) const

inline

Definition at line 140 of file Variable.h.

References FLAG_MULTIPLE, and flags.

{ return flags & FLAG_MULTIPLE; }

isOptional()

bool PhysicsTools::Variable::isOptional ( ) const

inline

Definition at line 139 of file Variable.h.

References FLAG_OPTIONAL, and flags.

{ return flags & FLAG_OPTIONAL; }

Member Data Documentation

flags

Flags PhysicsTools::Variable::flags

private

Definition at line 144 of file Variable.h.

Referenced by getFlags(), isMultiple(), and isOptional().

name

AtomicId PhysicsTools::Variable::name

private

Definition at line 143 of file Variable.h.

Referenced by FWLite.ElectronMVAID::__call__(), dirstructure.Directory::__create_pie_image(), DisplayManager.DisplayManager::__del__(), dqm_interfaces.DirID::__eq__(), dirstructure.Directory::__get_full_path(), dirstructure.Comparison::__get_img_name(), dirstructure.Comparison::__make_image(), dirstructure.Directory::__repr__(), dqm_interfaces.DirID::__repr__(), dirstructure.Comparison::__repr__(), config.CFG::__str__(), FWLite.WorkingPoints::_reformat_cut_definitions(), dirstructure.Directory::calcStats(), validation.Sample::digest(), python.rootplot.utilities.Hist::divide(), python.rootplot.utilities.Hist::divide_wilson(), DisplayManager.DisplayManager::Draw(), utils.StatisticalTest::get_status(), getName(), VIDSelectorBase.VIDSelectorBase::initialize(), dirstructure.Directory::print_report(), python.rootplot.utilities.Hist::TGraph(), and python.rootplot.utilities.Hist::TH1F().