Abstract base class implements parameter storage and access. More...

#include <OneParameter.h>

Inheritance diagram for MEAL::OneParameter:
MEAL::ParameterPolicy MEAL::FunctionPolicy Reference::Able Reference::HeapTracked MEAL::CyclicParameter

Public Member Functions

 OneParameter (Function *context=0)
 Default constructor.
 
 OneParameter (const OneParameter &np)
 Copy constructor.
 
OneParameteroperator= (const OneParameter &np)
 Assignment operator.
 
OneParameterclone (Function *context) const
 Clone operator. More...
 
std::string get_name () const
 Return the name of the parameter.
 
void set_name (const std::string &_name)
 Set the name of the parameter.
 
std::string get_description () const
 Return the description of the parameter.
 
void set_description (const std::string &_description)
 Set the description of the parameter.
 
virtual double get_param () const
 Return the value of the parameter.
 
virtual void set_param (double value)
 Set the value of the parameter. More...
 
double get_variance () const
 Return the variance of the parameter.
 
void set_variance (double value)
 Set the variance of the parameter.
 
bool get_infit () const
 Return true if parameter is to be fitted.
 
void set_infit (bool flag=true)
 Set flag for parameter to be fitted.
 
unsigned get_nparam () const
 Return the number of parameters.
 
std::string get_name (unsigned index) const
 Return the name of the specified parameter.
 
void set_name (unsigned index, const std::string &_name)
 Set the name of the specified parameter.
 
std::string get_description (unsigned index) const
 Return the description of the specified parameter.
 
void set_description (unsigned index, const std::string &_description)
 Set the description of the specified parameter.
 
double get_param (unsigned index) const
 Return the value of the specified parameter.
 
void set_param (unsigned index, double value)
 Set the value of the specified parameter.
 
double get_variance (unsigned index) const
 Return the variance of the specified parameter.
 
void set_variance (unsigned index, double value)
 Set the variance of the specified parameter.
 
bool get_infit (unsigned index) const
 Return true if parameter at index is to be fitted.
 
void set_infit (unsigned index, bool flag)
 Set flag for parameter at index to be fitted.
 
- Public Member Functions inherited from MEAL::FunctionPolicy
 FunctionPolicy (Function *context=0)
 Default constructor.
 
 ~FunctionPolicy ()
 Destructor. More...
 
Functionget_context () const
 Return the Function for whom this policy operates.
 
- Public Member Functions inherited from Reference::Able
 Able (const Able &)
 
Ableoperator= (const Able &)
 
unsigned get_reference_count () const
 
- Public Member Functions inherited from Reference::HeapTracked
 HeapTracked (const HeapTracked &)
 
HeapTrackedoperator= (const HeapTracked &)
 
bool __is_on_heap () const
 

Protected Member Functions

void range_check (unsigned index, const char *method) const
 Ensure that index <= get_nparam.
 
- Protected Member Functions inherited from MEAL::ParameterPolicy
 ParameterPolicy (Function *context)
 Default destructor.
 
- Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 

Additional Inherited Members

- Static Public Member Functions inherited from Reference::Able
static size_t get_instance_count ()
 
- Static Public Member Functions inherited from Reference::HeapTracked
static void * operator new (size_t size, void *ptr=0)
 
static void operator delete (void *location, void *ptr)
 
static void operator delete (void *location)
 
static size_t get_heap_queue_size ()
 
- Static Public Attributes inherited from MEAL::ParameterPolicy
static bool auto_install = true
 Install policy upon construction. More...
 

Detailed Description

Abstract base class implements parameter storage and access.

Member Function Documentation

◆ clone()

MEAL::OneParameter * MEAL::OneParameter::clone ( Function context) const
virtual

Clone operator.

Clone construtor.

Implements MEAL::ParameterPolicy.

◆ set_param()

void MEAL::OneParameter::set_param ( double  value)
virtual

Set the value of the parameter.

Set the value of the specified parameter.

Reimplemented in MEAL::CyclicParameter.

References MEAL::Function::very_verbose.

Referenced by MEAL::CyclicParameter::check(), MEAL::CyclicParameter::check_elevation(), and MEAL::Gain< Parent >::Gain().


The documentation for this class was generated from the following files:

Generated using doxygen 1.8.17