FGTable.h

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 Header:       FGTable.h
 Author:       Jon S. Berndt
 Date started: 1/9/2001
 
 ------------- 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.
 
HISTORY
--------------------------------------------------------------------------------
JSB  1/9/00          Created
ADM  2026/04/17      Added support for 4D and higher tables.
 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#ifndef FGTABLE_H
#define FGTABLE_H
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#include <memory>
#include <vector>
 
#include "FGParameter.h"
#include "math/FGPropertyValue.h"
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
namespace JSBSim {
 
class Element;
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DOCUMENTATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
class JSBSIM_API FGTable : public FGParameter, public FGJSBBase
{
public:
  ~FGTable();
 
  FGTable(const FGTable& table);
  /* MSVC issues an error C2280 if not defined : it is needed by
     std::unique_ptr<FGTable>.
     See StackOverflow: https://stackoverflow.com/questions/31264984/c-compiler-error-c2280-attempting-to-reference-a-deleted-function-in-visual */
  FGTable& operator=(const FGTable&);
 
  FGTable (std::shared_ptr<FGPropertyManager> propMan, Element* el,
           const std::string& prefix="");
  FGTable (int);
  FGTable (int, int);
 
  double GetValue(void) const;
  double GetValue(double key) const;
  double GetValue(double rowKey, double colKey) const;
  double GetValue(double rowKey, double colKey, double TableKey) const;
  double GetValue(double a1, double a2, double a3, double a4) const;
  double GetValue(double a1, double a2, double a3, double a4, double a5) const;
  double GetValue(double a1, double a2, double a3, double a4, double a5,
                  double a6) const;
  double GetValue(const std::vector<double>& keys) const;
 
  double GetMinValue(void) const;
  double GetMinValue(double colKey) const;
  double GetMinValue(double colKey, double TableKey) const;
 
  void operator<<(std::istream&);
  FGTable& operator<<(const double x);
 
  double GetElement(unsigned int r, unsigned int c) const;
  double operator()(unsigned int r, unsigned int c) const
  { return GetElement(r, c); }
 
  void SetRowIndexProperty(SGPropertyNode *node)
  { SetLookupProperty(eRow, new FGPropertyValue(node)); }
  void SetColumnIndexProperty(SGPropertyNode *node)
  { SetLookupProperty(eColumn, new FGPropertyValue(node)); }
 
  unsigned int GetNumRows() const {return nRows;}
 
  void Print(void);
 
  std::string GetName(void) const {return Name;}
 
private:
  enum type {tt1D, tt2D, ttND} Type;
  enum axis {eRow=0, eColumn, eTable};
  bool internal = false;
  std::shared_ptr<FGPropertyManager> PropertyManager; // Property root used to do late binding.
  std::vector<FGPropertyValue_ptr> lookupProperty;
  mutable std::vector<double> lookupPropertyValues;
  std::vector<double> Data;
  std::vector<std::unique_ptr<FGTable>> Tables;
  unsigned int nRows = 0u, nCols = 0u, nDims = 0u;
  std::string Name;
 
  void SetLookupProperty(unsigned int axis, FGPropertyValue_ptr node)
  {
    if (lookupProperty.size() <= axis) lookupProperty.resize(axis + 1u);
    lookupProperty[axis] = node;
  }
 
  bool HasLookupProperty(unsigned int axis) const
  {
    return axis < lookupProperty.size() && lookupProperty[axis];
  }
 
  double GetValue(const double* keys) const;
  void bind(Element* el, const std::string& Prefix);
  void missingData(Element *el, unsigned int expected_size, size_t actual_size);
  void Debug(int from);
};
}
//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
#endif