CachingVariable Class Reference

#include <CachingVariable.h>

Inheritance diagram for CachingVariable:

Classes
struct	CachingVariableFactoryArg

Public Types
typedef std::pair< bool, valueType >	evalType
typedef double	valueType
typedef std::map< std::string, const CachingVariable * >	vMap

Public Member Functions
void	addDescriptionLine (const std::string &s)
	CachingVariable (std::string m, std::string n, const edm::ParameterSet &iConfig, edm::ConsumesCollector &iC)
bool	compute (const edm::Event &iEvent) const
const Description &	description () const
const std::string &	holderName () const
const std::string &	method () const
const std::string &	name () const
valueType	operator() (const edm::Event &iEvent) const
void	print () const
void	setHolder (std::string hn) const
virtual	~CachingVariable ()

Protected Member Functions
evalType &	baseEval (const edm::Event &iEvent) const
virtual evalType	eval (const edm::Event &iEvent) const
bool	notSeenThisEventAlready (const edm::Event &iEvent) const
void	setCache (valueType &v) const
void	setNotCompute () const

Protected Attributes
evalType	cache_
edm::ParameterSet	conf_
Description	d_
edm::Event::CacheIdentifier_t	eventCacheID_ = 0
std::string	holderName_
std::string	method_
std::string	name_

Friends
class	VariableComputer

Detailed Description

Definition at line 40 of file CachingVariable.h.

Member Typedef Documentation

evalType

typedef std::pair<bool, valueType> CachingVariable::evalType

Definition at line 44 of file CachingVariable.h.

valueType

typedef double CachingVariable::valueType

Definition at line 43 of file CachingVariable.h.

vMap

typedef std::map<std::string, const CachingVariable*> CachingVariable::vMap

Definition at line 45 of file CachingVariable.h.

Constructor & Destructor Documentation

CachingVariable()

CachingVariable::CachingVariable ( std::string  m, std::string  n, const edm::ParameterSet &  iConfig, edm::ConsumesCollector &  iC  )

inline

Definition at line 55 of file CachingVariable.h.

      : cache_(std::make_pair(false, 0)), method_(m), name_(n), conf_(iConfig) {}

~CachingVariable()

virtual CachingVariable::~CachingVariable ( )

inlinevirtual

Definition at line 58 of file CachingVariable.h.

{}

Member Function Documentation

addDescriptionLine()

void CachingVariable::addDescriptionLine ( const std::string &  s )

inline

Definition at line 69 of file CachingVariable.h.

{ d_.addLine(s); }

References Description::addLine(), d_, and alignCSCRings::s.

Referenced by ExpressionVariable< Object, label >::ExpressionVariable(), TwoObjectVariable< LHS, lLHS, RHS, lRHS, Calculator >::TwoObjectVariable(), and VariablePower::VariablePower().

baseEval()

evalType& CachingVariable::baseEval ( const edm::Event &  iEvent ) const

inlineprotected

Definition at line 90 of file CachingVariable.h.

                                                   {
    if (notSeenThisEventAlready(iEvent)) {
      LogDebug("CachingVariable") << name_ + ":" + holderName_ << " is checking once";
      cache_ = eval(iEvent);
    }
    return cache_;
  }

References cache_, eval(), holderName_, iEvent, LogDebug, name_, and notSeenThisEventAlready().

Referenced by compute(), and operator()().

compute()

bool CachingVariable::compute ( const edm::Event &  iEvent ) const

inline

Definition at line 61 of file CachingVariable.h.

{ return baseEval(iEvent).first; }

References baseEval(), and iEvent.

Referenced by ConfigurableHisto::fill(), and SplittingConfigurableHisto::fill().

description()

const Description& CachingVariable::description ( ) const

inline

Definition at line 68 of file CachingVariable.h.

{ return d_; }

References d_.

Referenced by print().

eval()

virtual evalType CachingVariable::eval ( const edm::Event &  iEvent ) const

inlineprotectedvirtual

Reimplemented in Splitter, SimpleValueVectorVariable< TYPE >, SimpleValueVariable< TYPE >, VariablePower, TwoObjectVariable< LHS, lLHS, RHS, lRHS, Calculator >, ExpressionVariable< Object, label >, VarSplitter, ComputedVariable, and HLTBitVariable.

Definition at line 107 of file CachingVariable.h.

{ return std::make_pair(false, 0); };

Referenced by baseEval().

holderName()

const std::string& CachingVariable::holderName ( ) const

inline

Definition at line 70 of file CachingVariable.h.

{ return holderName_; }

References holderName_.

method()

const std::string& CachingVariable::method ( ) const

inline

Definition at line 67 of file CachingVariable.h.

{ return method_; }

References method_.

Referenced by ExpressionVariable< Object, label >::eval().

name()

const std::string& CachingVariable::name ( void  ) const

inline

Definition at line 66 of file CachingVariable.h.

{ return name_; }

References name_.

Referenced by config.CFG::__str__(), SplittingConfigurableHisto::book(), validation.Sample::digest(), ExpressionVariable< Object, label >::ExpressionVariable(), TwoObjectVariable< LHS, lLHS, RHS, lRHS, Calculator >::objects(), print(), and VarSplitter::VarSplitter().

notSeenThisEventAlready()

bool CachingVariable::notSeenThisEventAlready ( const edm::Event &  iEvent ) const

inlineprotected

Definition at line 97 of file CachingVariable.h.

                                                             {
    bool retValue = (std::numeric_limits<edm::Event::CacheIdentifier_t>::max() != eventCacheID_ and
                     eventCacheID_ != iEvent.cacheIdentifier());
    if (retValue) {
      eventCacheID_ = iEvent.cacheIdentifier();
    }
    return retValue;
  }

References eventCacheID_, iEvent, and SiStripPI::max.

Referenced by baseEval().

operator()()

valueType CachingVariable::operator() ( const edm::Event &  iEvent ) const

inline

Definition at line 64 of file CachingVariable.h.

{ return baseEval(iEvent).second; }

References baseEval(), and iEvent.

print()

void CachingVariable::print ( void  ) const

inline

Definition at line 73 of file CachingVariable.h.

{ edm::LogVerbatim("CachingVariable") << name() << "\n" << description().text(); }

References description(), name(), and Description::text().

setCache()

void CachingVariable::setCache ( valueType &  v ) const

inlineprotected

Definition at line 82 of file CachingVariable.h.

                                    {
    cache_.first = true;
    cache_.second = v;
  }

References cache_, and findQualityFiles::v.

setHolder()

void CachingVariable::setHolder ( std::string  hn ) const

inline

Definition at line 71 of file CachingVariable.h.

{ holderName_ = hn; }

References holderName_.

setNotCompute()

void CachingVariable::setNotCompute ( ) const

inlineprotected

Definition at line 86 of file CachingVariable.h.

                             {
    cache_.first = false;
    cache_.second = 0;
  }

References cache_.

Friends And Related Function Documentation

VariableComputer

friend class VariableComputer

friend

Definition at line 111 of file CachingVariable.h.

Member Data Documentation

cache_

evalType CachingVariable::cache_

mutableprotected

Definition at line 76 of file CachingVariable.h.

Referenced by baseEval(), ComputedVariable::eval(), setCache(), and setNotCompute().

conf_

edm::ParameterSet CachingVariable::conf_

protected

Definition at line 110 of file CachingVariable.h.

Referenced by Splitter::label(), Splitter::shortLabel(), and VarSplitter::VarSplitter().

d_

Description CachingVariable::d_

protected

Definition at line 107 of file CachingVariable.h.

Referenced by addDescriptionLine(), and description().

eventCacheID_

edm::Event::CacheIdentifier_t CachingVariable::eventCacheID_ = 0

mutableprotected

Definition at line 77 of file CachingVariable.h.

Referenced by notSeenThisEventAlready().

holderName_

std::string CachingVariable::holderName_

mutableprotected

Definition at line 81 of file CachingVariable.h.

Referenced by baseEval(), holderName(), and setHolder().

method_

std::string CachingVariable::method_

protected

Definition at line 79 of file CachingVariable.h.

Referenced by method().

name_

std::string CachingVariable::name_

protected

Definition at line 80 of file CachingVariable.h.

Referenced by baseEval(), and name().