AbsElectronicODERHS Class Reference

#include <AbsElectronicODERHS.h>

Inheritance diagram for AbsElectronicODERHS:

Public Member Functions
	AbsElectronicODERHS ()
	AbsElectronicODERHS (const HcalInterpolatedPulse &pulse)
bool	allParametersSet () const
virtual unsigned	controlNode () const
const std::vector< double > &	getAllParameters () const
double	getParameter (const unsigned which) const
const HcalInterpolatedPulse &	inputPulse () const
HcalInterpolatedPulse &	inputPulse ()
virtual unsigned	nParameters () const =0
virtual unsigned	numberOfNodes () const =0
virtual unsigned	outputNode () const =0
template<class Pulse >
void	setInputPulse (const Pulse &pulse)
void	setLeadingParameters (const double *values, const unsigned len)
void	setLeadingParameters (const std::vector< double > &values)
void	setParameter (const unsigned which, const double value)
virtual	~AbsElectronicODERHS ()
Public Member Functions inherited from AbsODERHS
virtual void	calc (double t, const double *x, unsigned lenX, double *derivative)=0
virtual AbsODERHS *	clone () const =0
virtual	~AbsODERHS ()

Static Public Attributes
static const unsigned	invalidNode = UINT_MAX - 1U

Protected Attributes
HcalInterpolatedPulse	inputPulse_
std::vector< double >	params_

Private Member Functions
void	initialize ()

Private Attributes
bool	allSet_
bool	initialized_
std::vector< unsigned char >	paramMask_

Detailed Description

Definition at line 16 of file AbsElectronicODERHS.h.

Constructor & Destructor Documentation

AbsElectronicODERHS::AbsElectronicODERHS ( )

inline

Definition at line 21 of file AbsElectronicODERHS.h.

: initialized_(false), allSet_(false) {}

AbsElectronicODERHS::AbsElectronicODERHS ( const HcalInterpolatedPulse &  pulse )

inlineexplicit

Definition at line 23 of file AbsElectronicODERHS.h.

        : inputPulse_(pulse) {}

virtual AbsElectronicODERHS::~AbsElectronicODERHS ( )

inlinevirtual

Definition at line 26 of file AbsElectronicODERHS.h.

{}

Member Function Documentation

bool AbsElectronicODERHS::allParametersSet ( ) const

inline

Definition at line 52 of file AbsElectronicODERHS.h.

References allSet_, KineDebug3::count(), i, nParameters(), and paramMask_.

Referenced by getAllParameters().

    {
        // Raise "allSet_" flag if all parameters have been set
        if (!allSet_)
        {
            const unsigned nExpected = this->nParameters();
            if (nExpected)
            {
                if (paramMask_.size() != nExpected)
                    return false;
                unsigned count = 0;
                const unsigned char* mask = &paramMask_[0];
                for (unsigned i=0; i<nExpected; ++i)
                    count += mask[i];
                allSet_ = count == nExpected;
            }
            else
                allSet_ = true;
        }
        return allSet_;
    }

virtual unsigned AbsElectronicODERHS::controlNode ( ) const

inlinevirtual

Reimplemented in DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >.

Definition at line 46 of file AbsElectronicODERHS.h.

References invalidNode.

{return invalidNode;}

const std::vector<double>& AbsElectronicODERHS::getAllParameters ( ) const

inline

Definition at line 90 of file AbsElectronicODERHS.h.

References allParametersSet(), Exception, and params_.

    {
        if (!allParametersSet()) throw cms::Exception(
            "In AbsElectronicODERHS::getAllParameters: "
            "some parameter values were not established yet");
        return params_;
    }

double AbsElectronicODERHS::getParameter ( const unsigned  which ) const

inline

Definition at line 82 of file AbsElectronicODERHS.h.

References paramMask_, params_, and eostools::which().

    {
        if (!paramMask_.at(which)) throw cms::Exception(
            "In AbsElectronicODERHS::getParameter: no such parameter or "
            "parameter value is not established yet");
        return params_[which];
    }

void AbsElectronicODERHS::initialize ( )

inlineprivate

Definition at line 130 of file AbsElectronicODERHS.h.

References i, initialized_, nParameters(), paramMask_, and params_.

Referenced by setLeadingParameters(), and setParameter().

    {
        const unsigned nExpected = this->nParameters();
        if (nExpected)
        {
            params_.resize(nExpected);
            paramMask_.resize(nExpected);
            for (unsigned i=0; i<nExpected; ++i)
                paramMask_[i] = 0;
        }
        initialized_ = true;
    }

const HcalInterpolatedPulse& AbsElectronicODERHS::inputPulse ( ) const

inline

Definition at line 28 of file AbsElectronicODERHS.h.

References inputPulse_.

{return inputPulse_;}

HcalInterpolatedPulse& AbsElectronicODERHS::inputPulse ( )

inline

Definition at line 30 of file AbsElectronicODERHS.h.

References inputPulse_.

{return inputPulse_;}

virtual unsigned AbsElectronicODERHS::nParameters ( ) const

pure virtual

Implemented in DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >.

Referenced by allParametersSet(), and initialize().

virtual unsigned AbsElectronicODERHS::numberOfNodes ( ) const

pure virtual

Implemented in DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >.

virtual unsigned AbsElectronicODERHS::outputNode ( ) const

pure virtual

Implemented in DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >.

template<class Pulse >

void AbsElectronicODERHS::setInputPulse ( const Pulse &  pulse )

inline

Definition at line 33 of file AbsElectronicODERHS.h.

References inputPulse_.

{inputPulse_ = pulse;}

void AbsElectronicODERHS::setLeadingParameters ( const double *  values, const unsigned  len  )

inline

Definition at line 98 of file AbsElectronicODERHS.h.

References assert(), i, initialize(), initialized_, min(), paramMask_, and params_.

Referenced by setLeadingParameters().

    {
        if (len)
        {
            assert(values);
            if (!initialized_)
                initialize();
            const unsigned sz = params_.size();
            const unsigned imax = std::min(sz, len);
            for (unsigned i=0; i<imax; ++i)
            {
                params_[i] = values[i];
                paramMask_[i] = 1;
            }
        }
    }

void AbsElectronicODERHS::setLeadingParameters ( const std::vector< double > &  values )

inline

Definition at line 115 of file AbsElectronicODERHS.h.

References setLeadingParameters().

    {
        if (!values.empty())
            setLeadingParameters(&values[0], values.size());
    }

void AbsElectronicODERHS::setParameter ( const unsigned  which, const double  value  )

inline

Definition at line 74 of file AbsElectronicODERHS.h.

References initialize(), initialized_, paramMask_, params_, relativeConstraints::value, and eostools::which().

Referenced by editorTools.UserCodeTool::__call__(), metTools.AddMETCollection::__call__(), and editorTools.ChangeSource::__call__().

    {
        if (!initialized_)
            initialize();
        paramMask_.at(which) = 1;
        params_[which] = value;
    }

Member Data Documentation

bool AbsElectronicODERHS::allSet_

mutableprivate

Definition at line 128 of file AbsElectronicODERHS.h.

Referenced by allParametersSet().

bool AbsElectronicODERHS::initialized_

private

Definition at line 127 of file AbsElectronicODERHS.h.

Referenced by initialize(), setLeadingParameters(), and setParameter().

HcalInterpolatedPulse AbsElectronicODERHS::inputPulse_

protected

Definition at line 122 of file AbsElectronicODERHS.h.

Referenced by inputPulse(), and setInputPulse().

const unsigned AbsElectronicODERHS::invalidNode = UINT_MAX - 1U

static

Definition at line 19 of file AbsElectronicODERHS.h.

Referenced by controlNode().

std::vector<unsigned char> AbsElectronicODERHS::paramMask_

private

Definition at line 126 of file AbsElectronicODERHS.h.

Referenced by allParametersSet(), getParameter(), initialize(), setLeadingParameters(), and setParameter().

std::vector<double> AbsElectronicODERHS::params_

protected

Definition at line 123 of file AbsElectronicODERHS.h.

Referenced by getAllParameters(), getParameter(), initialize(), setLeadingParameters(), and setParameter().