GyotoObject.h

Go to the documentation of this file.

 
/*
    Copyright 2014-2016 Thibaut Paumard
 
    This file is part of Gyoto.
 
    Gyoto is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    Gyoto 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 General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with Gyoto.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#ifndef __GyotoObject_H_
#define __GyotoObject_H_
 
#include "GyotoConfig.h"
#include "GyotoSmartPointer.h"
#include <string>
#include <vector>
 
namespace Gyoto {
  class Object;
  class Property;
  class Value;
  class FactoryMessenger;
}
 
 
#define GYOTO_OBJECT_ACCESSORS_STRING(method)                           \
  virtual void method(std::string const&);                              \
  virtual std::string method() const;
 
 
#define GYOTO_OBJECT_ACCESSORS(type, method)                            \
  virtual void method(type);                                            \
  virtual type method() const;
 
 
#define GYOTO_OBJECT_ACCESSORS_UNIT(method)                             \
  GYOTO_OBJECT_ACCESSORS(double, method)                                \
  virtual void method(double, std::string const &);                     \
  virtual double method(std::string const &) const;
 
 
#define GYOTO_OBJECT \
  static Property const  properties[];                  \
  virtual Property const * getProperties() const;       \
  static const std::string builtinPluginValue;          \
  virtual void plugins(std::vector<std::string> const & plugname);      \
  virtual std::vector<std::string> plugins() const
 
 
#define GYOTO_OBJECT_THREAD_SAFETY              \
  virtual bool isThreadSafe() const
 
 
class Gyoto::Object
{
 protected:
 
  std::string kind_;
 
 
  std::vector<std::string> plugins_;
 
 public:
 
  virtual bool isThreadSafe() const;
 
 
  GYOTO_OBJECT;
  Object (std::string const &kind) ;
 
  Object () ;
 
  Object (Object const &orig) ;
 
  virtual ~Object();
 
  void set(Property const &p, Value val);
 
  void set(Property const &p, Value val, std::string const &unit);
 
  void set(std::string const &pname, Value val);
 
  void set(std::string const &pname, Value val, std::string const &unit);
 
  Value get(Property const &p) const;
 
  Value get(std::string const &pname) const;
 
  Value get(Property const &p, std::string const &unit) const;
 
  Value get(std::string const &pname, std::string const &unit) const;
 
 
  Property const * property(std::string const pname) const;
 
#ifdef GYOTO_USE_XERCES
 
  virtual void fillProperty(Gyoto::FactoryMessenger *fmp,
                            Property const &p) const ;
 
 
  virtual void fillElement(Gyoto::FactoryMessenger *fmp) const ;
 
  
 
  virtual void setParameters(Gyoto::FactoryMessenger *fmp) ;
#endif
  virtual int setParameter(std::string name,
                            std::string content,
                            std::string unit);
 
   virtual void setParameter(Gyoto::Property const &p,
                            std::string const &name,
                            std::string const &content,
                            std::string const &unit);
 
   std::string describeProperty(Gyoto::Property const &p) const ;
 
   void help() const ;
};
 
#endif