FGFunction.h

Go to the documentation of this file.

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
Header: FGFunction.h
Author: Jon Berndt
Date started: August 25 2004
 
 ------------- Copyright (C) 2001  Jon S. Berndt (jon@jsbsim.org) -------------
 
 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Lesser General Public License as published by the Free
 Software Foundation; either version 2 of the License, or (at your option) any
 later version.
 
 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 details.
 
 You should have received a copy of the GNU Lesser General Public License along
 with this program; if not, write to the Free Software Foundation, Inc., 59
 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
 Further information about the GNU Lesser General Public License can also be
 found on the world wide web at http://www.gnu.org.
 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#ifndef FGFUNCTION_H
#define FGFUNCTION_H
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#include "FGParameter.h"
#include "input_output/FGPropertyManager.h"
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
namespace JSBSim {
 
class Element;
class FGPropertyValue;
class FGFDMExec;
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DOCUMENTATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/

 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DECLARATION: FGFunction
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
// Todo: Does this class need a copy constructor, like FGLGear?
 
class FGFunction : public FGParameter, public FGJSBBase
{
public:
  FGFunction()
    : cached(false), cachedValue(-HUGE_VAL), PropertyManager(nullptr),
      pNode(nullptr), pCopyTo(nullptr) {}
 
  explicit FGFunction(FGPropertyManager* pm)
    : FGFunction()
  { PropertyManager = pm; }

  FGFunction(FGFDMExec* fdmex, Element* element, const std::string& prefix="",
             FGPropertyValue* var=0L);

  ~FGFunction(void) override;

  double GetValue(void) const override;

  std::string GetValueAsString(void) const;

  std::string GetName(void) const override {return Name;}

  bool IsConstant(void) const override;

  void cacheValue(bool shouldCache);
 
  enum class OddEven {Either, Odd, Even};
 
protected:
  bool cached;
  double cachedValue;
  std::vector <FGParameter_ptr> Parameters;
  FGPropertyManager* PropertyManager;
  FGPropertyNode_ptr pNode;
 
  void Load(Element* element, FGPropertyValue* var, FGFDMExec* fdmex,
            const std::string& prefix="");
  virtual void bind(Element*, const std::string&);
  void CheckMinArguments(Element* el, unsigned int _min);
  void CheckMaxArguments(Element* el, unsigned int _max);
  void CheckOddOrEvenArguments(Element* el, OddEven odd_even);
  std::string CreateOutputNode(Element* el, const std::string& Prefix);
 
private:
  std::string Name;
  FGPropertyNode_ptr pCopyTo; // Property node for CopyTo property string
 
  void Debug(int from);
};
 
} // namespace JSBSim
 
#endif