MEAL::CyclicParameter Class Reference

A periodic parameter with bounds. More...

#include <CyclicParameter.h>

Inheritance diagram for MEAL::CyclicParameter:

Public Member Functions
	CyclicParameter (Function *context=0)
	Default constructor.
	CyclicParameter (const CyclicParameter &np)
	Copy constructor.
	CyclicParameter (const OneParameter &np)
	Copy constructor.
CyclicParameter &	operator= (const CyclicParameter &np)
	Assignment operator.
CyclicParameter *	clone (Function *context) const
	Clone operator.
void	set_lower_bound (double bound)
	Set the lower bound on the parameter value.
void	set_upper_bound (double bound)
	Set the upper bound on the parameter value.
void	set_period (double period)
	Set the period of the parameter value.
void	set_azimuth (CyclicParameter *azimuth)
	Set the matching azimuth and behave like an elevation.
void	set_param (double value)
	Set the value of the parameter.
double	get_param () const
	Get the value of the parameter.
Public Member Functions inherited from MEAL::OneParameter
	OneParameter (Function *context=0)
	Default constructor.
	OneParameter (const OneParameter &np)
	Copy constructor.
OneParameter &	operator= (const OneParameter &np)
	Assignment operator.
OneParameter *	clone (Function *context) const
	Clone operator.
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.
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.
Function *	get_context () const
	Return the Function for whom this policy operates.
Public Member Functions inherited from Reference::Able
	Able (const Able &)
Able &	operator= (const Able &)
unsigned	get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)
HeapTracked &	operator= (const HeapTracked &)
bool	__is_on_heap () const

Protected Member Functions
void	check (double value)
	Ensure that the value is within the bounds.
void	check_elevation ()
	Check to see if elevation needs correction.
Protected Member Functions inherited from MEAL::OneParameter
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.

Detailed Description

A periodic parameter with bounds.

By default, the period is , the lower bound is and the upper bound is .

Member Function Documentation

clone()

MEAL::CyclicParameter * MEAL::CyclicParameter::clone ( Function * context ) const

virtual

Clone operator.

Clone construtor.

Implements MEAL::ParameterPolicy.

References CyclicParameter().

get_param()

double MEAL::CyclicParameter::get_param ( ) const

virtual

Get the value of the parameter.

Reimplemented from MEAL::OneParameter.

References check_elevation(), CyclicParameter(), and MEAL::OneParameter::get_param().

Referenced by set_azimuth(), set_lower_bound(), set_period(), and set_upper_bound().

set_param()

void MEAL::CyclicParameter::set_param ( double value )

virtual

Set the value of the parameter.

Set the value of the specified parameter.

Reimplemented from MEAL::OneParameter.

References check().

---

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

• CyclicParameter.h
• CyclicParameter.C