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 39 of file CachingVariable.h.

Member Typedef Documentation

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

Definition at line 43 of file CachingVariable.h.

typedef double CachingVariable::valueType

Definition at line 42 of file CachingVariable.h.

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

Definition at line 44 of file CachingVariable.h.

Constructor & Destructor Documentation

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

inline

Definition at line 53 of file CachingVariable.h.

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

virtual CachingVariable::~CachingVariable ( )

inlinevirtual

Definition at line 57 of file CachingVariable.h.

{}

Member Function Documentation

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

inline

Definition at line 68 of file CachingVariable.h.

References Description::addLine(), and d_.

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

{ d_.addLine(s);}

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

inlineprotected

Definition at line 90 of file CachingVariable.h.

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

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

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

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

inline

Definition at line 60 of file CachingVariable.h.

References baseEval().

Referenced by VarSplitter::eval(), VariablePower::eval(), ConfigurableHisto::fill(), SplittingConfigurableHisto::fill(), and VariableEventSelector::select().

{    return baseEval(iEvent).first;  }

const Description& CachingVariable::description ( ) const

inline

Definition at line 67 of file CachingVariable.h.

References d_.

Referenced by print().

{ return d_;}

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

inlineprotectedvirtual

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

Definition at line 107 of file CachingVariable.h.

Referenced by baseEval().

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

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

inline

Definition at line 69 of file CachingVariable.h.

References holderName_.

{ return holderName_;}

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

inline

Definition at line 66 of file CachingVariable.h.

References method_.

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

{ return method_;}

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

inline

Definition at line 65 of file CachingVariable.h.

References name_.

Referenced by cuy.divideElement::__init__(), cuy.plotElement::__init__(), cuy.additionElement::__init__(), cuy.superimposeElement::__init__(), cuy.graphElement::__init__(), SplittingConfigurableHisto::book(), ExpressionVariable< Object, label >::ExpressionVariable(), TwoObjectVariable< LHS, lLHS, RHS, lRHS, Calculator >::objects(), print(), SplittingConfigurableHisto::SplittingConfigurableHisto(), and VarSplitter::VarSplitter().

{return name_;}

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

inlineprotected

Definition at line 97 of file CachingVariable.h.

References edm::Event::cacheIdentifier(), eventCacheID_, and bookConverter::max.

Referenced by baseEval().

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

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

inline

Definition at line 63 of file CachingVariable.h.

References baseEval().

{    return baseEval(iEvent).second;  }

void CachingVariable::print ( void  ) const

inline

Definition at line 72 of file CachingVariable.h.

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

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

void CachingVariable::setCache ( valueType &  v ) const

inlineprotected

Definition at line 84 of file CachingVariable.h.

References cache_, eventCacheID_, bookConverter::max, and findQualityFiles::v.

                                     {
    eventCacheID_ = std::numeric_limits<edm::Event::CacheIdentifier_t>::max();
    cache_.first=true; cache_.second = v;}

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

inline

Definition at line 70 of file CachingVariable.h.

References holderName_.

{ holderName_=hn;}

void CachingVariable::setNotCompute ( ) const

inlineprotected

Definition at line 87 of file CachingVariable.h.

References cache_, eventCacheID_, and bookConverter::max.

                             {
    eventCacheID_ = std::numeric_limits<edm::Event::CacheIdentifier_t>::max();
    cache_.first=false; cache_.second = 0;}

Friends And Related Function Documentation

friend class VariableComputer

friend

Definition at line 111 of file CachingVariable.h.

Member Data Documentation

evalType CachingVariable::cache_

mutableprotected

Definition at line 78 of file CachingVariable.h.

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

edm::ParameterSet CachingVariable::conf_

protected

Definition at line 110 of file CachingVariable.h.

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

Description CachingVariable::d_

protected

Definition at line 107 of file CachingVariable.h.

Referenced by addDescriptionLine(), and description().

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

mutableprotected

Definition at line 79 of file CachingVariable.h.

Referenced by notSeenThisEventAlready(), setCache(), and setNotCompute().

std::string CachingVariable::holderName_

mutableprotected

Definition at line 83 of file CachingVariable.h.

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

std::string CachingVariable::method_

protected

Definition at line 81 of file CachingVariable.h.

Referenced by method().

std::string CachingVariable::name_

protected

Definition at line 82 of file CachingVariable.h.

Referenced by baseEval(), and name().