OneParameter.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2005 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/MEAL/MEAL/OneParameter.h
 
#ifndef __OneParameter_H
#define __OneParameter_H
 
#include "MEAL/ParameterPolicy.h"
#include "Estimate.h"
#include "Error.h"
 
namespace MEAL {
  
  class OneParameter : public ParameterPolicy {
 
  public:

    OneParameter (Function* context = 0);

    OneParameter (const OneParameter& np);

    OneParameter& operator = (const OneParameter& np);

    OneParameter* clone (Function* context) const;

    std::string get_name () const
    {
      return name;
    }

    void set_name (const std::string& _name)
    {
      name = _name;
    }

    std::string get_description () const
    {
      return description;
    }

    void set_description (const std::string& _description)
    {
      description = _description;
    }

    virtual double get_param () const
    {
      return param.val;
    }

    virtual void set_param (double value);

    double get_variance () const
    {
      return param.var;
    }

    void set_variance (double value)
    {
      param.var = value;
    }

    bool get_infit () const
    {
      return fit;
    }

    void set_infit (bool flag = true)
    {
      fit = flag;
    }
 
    // ///////////////////////////////////////////////////////////////////
    //
    // Function implementation
    //
    // ///////////////////////////////////////////////////////////////////
 
    unsigned get_nparam () const
    {
      return 1;
    }

    std::string get_name (unsigned index) const
    {
      range_check (index, "MEAL::OneParameter::get_name");
      return name;
    }

    void set_name (unsigned index, const std::string& _name)
    {
      range_check (index, "MEAL::OneParameter::set_name");
      name = _name;
    }

    std::string get_description (unsigned index) const
    {
      range_check (index, "MEAL::OneParameter::get_description");
      return description;
    }

    void set_description (unsigned index, const std::string& _description)
    {
      range_check (index, "MEAL::OneParameter::set_description");
      description = _description;
    }

    double get_param (unsigned index) const
    {
      range_check (index, "MEAL::OneParameter::get_param");
      return get_param ();
    }

    void set_param (unsigned index, double value) 
    {
      range_check (index, "MEAL::OneParameter::set_param");
      set_param (value);
    }

    double get_variance (unsigned index) const
    {
      range_check (index, "MEAL::OneParameter::get_variance");
      return param.var;
    }

    void set_variance (unsigned index, double value)
    {
      range_check (index, "MEAL::OneParameter::set_variance");
      param.var = value;
    }

    bool get_infit (unsigned index) const
    {
      range_check (index, "MEAL::OneParameter::get_infit");
      return fit;
    }

    void set_infit (unsigned index, bool flag)
    {
      range_check (index, "MEAL::OneParameter::set_infit");
      fit = flag;
    }
 
  protected:

    void range_check (unsigned index, const char* method) const
    {
      if (index != 0)
        throw Error (InvalidRange, method, "index=%d != 0", index);
    }
 
  private:

    Estimate<double> param;

    bool fit;

    std::string name;

    std::string description;
 
  };
 
}
 
#endif