zd_function.hpp

/* zd_function.hpp */
/* $Id: zd_function.hpp,v 1.8 2007/04/14 00:33:33 vlad Exp $ */
#ifndef __zd_function_hpp
#define __zd_function_hpp

#include "zd_document.hpp"


typedef enum
{
  Z_F_ARG_HOR,  
  Z_F_ARG_VER   
}   ZdFuncArgDir;


class ZdFunction : public ZdDocument
{
public:

  ZdFunction (const char* szFuncName = NULL);

  virtual ~ZdFunction ();


  /*
   *  Run-time type identification facility
   */

  virtual bool      compatibleType (const char* szType) const;


  /*
   *  Basic functionality
   */

  virtual int       count () = 0;

  virtual double    arg (int i) = 0;

  virtual double    func (int i) = 0;


  /*
   *  Extended functionality with default implementation
   */

  virtual void      arg (std::vector<double>& vArg);

  virtual void      func (std::vector<double>& vFunc,
                  double fNull = 0.0);

  virtual bool      isNullAll ();

  virtual bool      isNullFunc (int i);

  virtual double    argStep ();

  virtual void      getArgBounds (double b[2]);

  virtual double    minArg () {
    double  b[2];
    getArgBounds(b);
    return b[0];
  }

  virtual double    maxArg () {
    double  b[2];
    getArgBounds(b);
    return b[1];
  }

  virtual void      getFuncBounds (double b[2]);

  double        minFunc () {
    double  b[2];
    getFuncBounds(b);
    return b[0];
  }

  virtual double    maxFunc () {
    double  b[2];
    getFuncBounds(b);
    return b[1];
  }

  virtual int       argIndex (double a);

  virtual double    funcInterp (double a);

  /*
   *  Additional functionality, not implemented at all by default
   */

  virtual void      setFunc (int i, double fNewValue);

  virtual void      makeNullFunc (int i);

  virtual void      makeNullAll ();

private:

  static int        s_iNameCounter;

  static char       *s_szOwnType;

};


#endif /* zd_function.hpp */