npstat::StorableMultivariateFunctor Class Reference

#include <StorableMultivariateFunctor.h>

Inheritance diagram for npstat::StorableMultivariateFunctor:

Public Member Functions
const std::string &	description () const
void	setDescription (const std::string &newDescription)
	StorableMultivariateFunctor ()
	StorableMultivariateFunctor (const std::string &descr)
void	validateDescription (const std::string &description) const
virtual	~StorableMultivariateFunctor ()
bool	operator== (const StorableMultivariateFunctor &r) const
bool	operator!= (const StorableMultivariateFunctor &r) const
virtual gs::ClassId	classId () const =0
virtual bool	write (std::ostream &of) const =0
Public Member Functions inherited from npstat::AbsMultivariateFunctor
virtual unsigned	maxDim () const
virtual unsigned	minDim () const =0
virtual double	operator() (const double *point, unsigned dim) const =0
virtual	~AbsMultivariateFunctor ()

Static Public Member Functions
static const char *	classname ()
static StorableMultivariateFunctor *	read (const gs::ClassId &id, std::istream &in)
static unsigned	version ()

Protected Member Functions
virtual bool	isEqual (const StorableMultivariateFunctor &) const =0

Private Attributes
std::string	description_

Detailed Description

Base class for storable multivariate functors

Definition at line 23 of file StorableMultivariateFunctor.h.

Constructor & Destructor Documentation

npstat::StorableMultivariateFunctor::StorableMultivariateFunctor ( )

inline

Definition at line 26 of file StorableMultivariateFunctor.h.

{}

npstat::StorableMultivariateFunctor::StorableMultivariateFunctor ( const std::string &  descr )

inlineexplicit

Functor description can be an arbitrary string

Definition at line 29 of file StorableMultivariateFunctor.h.

            : AbsMultivariateFunctor(), description_(descr) {}

virtual npstat::StorableMultivariateFunctor::~StorableMultivariateFunctor ( )

inlinevirtual

Definition at line 32 of file StorableMultivariateFunctor.h.

{}

Member Function Documentation

virtual gs::ClassId npstat::StorableMultivariateFunctor::classId ( ) const

pure virtual

Method related to "geners" I/O

Implemented in npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >, and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >.

static const char* npstat::StorableMultivariateFunctor::classname ( )

inlinestatic

Definition at line 65 of file StorableMultivariateFunctor.h.

            {return "npstat::StorableMultivariateFunctor";}

const std::string& npstat::StorableMultivariateFunctor::description ( ) const

inline

Retrieve the functor description

Definition at line 35 of file StorableMultivariateFunctor.h.

References description_.

Referenced by npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::isEqual(), npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::isEqual(), and validateDescription().

{return description_;}

virtual bool npstat::StorableMultivariateFunctor::isEqual ( const StorableMultivariateFunctor &  ) const

protectedpure virtual

Method needed to compare objects for equality. Must be overriden by derived classes. It is left up to the derived classes to decide whether they should compare description strings in order to establish equality.

Implemented in npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >, and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >.

Referenced by operator==().

bool npstat::StorableMultivariateFunctor::operator!= ( const StorableMultivariateFunctor &  r ) const

inline

Definition at line 54 of file StorableMultivariateFunctor.h.

References alignCSCRings::r.

            {return !(*this == r);}

bool npstat::StorableMultivariateFunctor::operator== ( const StorableMultivariateFunctor &  r ) const

inline

Do not override comparison operators in the derived classes, override the method "isEqual" instead.

Definition at line 52 of file StorableMultivariateFunctor.h.

References isEqual().

            {return (typeid(*this) == typeid(r)) && this->isEqual(r);}

StorableMultivariateFunctor * npstat::StorableMultivariateFunctor::read ( const gs::ClassId &  id, std::istream &  in  )

static

Definition at line 22 of file StorableMultivariateFunctor.cc.

References instance.

    {
        return StaticStorableMultivariateFunctorReader::instance().read(id, in);
    }

void npstat::StorableMultivariateFunctor::setDescription ( const std::string &  newDescription )

inline

Change the functor description

Definition at line 38 of file StorableMultivariateFunctor.h.

References description_.

            {description_ = newDescription;}

void npstat::StorableMultivariateFunctor::validateDescription

(

const std::string &

description

)

const

This method will throw npstat::NpstatRuntimeError in case functor description is different from the provided argument

Definition at line 6 of file StorableMultivariateFunctor.cc.

References description(), description_, and AlCaHLTBitMon_QueryRunRegistry::string.

    {
        if (description_ != description) 
        {
            std::string mesage = 
                "In StorableMultivariateFunctor::validateDescription: "
                "argument description string \"";
            mesage += description;
            mesage += "\" is different from the object description string \"";
            mesage += description_;
            mesage += "\"";
            throw npstat::NpstatRuntimeError(mesage.c_str());
        }
    }

static unsigned npstat::StorableMultivariateFunctor::version ( )

inlinestatic

Definition at line 67 of file StorableMultivariateFunctor.h.

Referenced by validation.Sample::datasetpattern(), and validation.Sample::filename().

{return 1;}

virtual bool npstat::StorableMultivariateFunctor::write ( std::ostream &  of ) const

pure virtual

Implemented in npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >, and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >.

Member Data Documentation

std::string npstat::StorableMultivariateFunctor::description_

private

Definition at line 82 of file StorableMultivariateFunctor.h.

Referenced by description(), setDescription(), and validateDescription().