Tool.hpp

Go to the documentation of this file.

// This file is part of GranOO, a workbench for DEM simulation.
//
// Author(s)    : - Damien Andre       IRCER/UNILIM, Limoges France
//                  <damien.andre@unilim.fr>
//                - Jean-luc Charles   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jean-luc.charles@ensam.eu>
//                - Jeremie Girardot   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jeremie.girardot@ensam.eu>
//                - Cedric Hubert      LAMIH/UPHF, Valenciennes France
//                  <cedric.hubert@uphf.fr>
//                - Ivan Iordanoff     Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <ivan.iordanoff@ensam.eu>
//
// Copyright (C) 2008-2019 D. Andre, JL. Charles, J. Girardot, C. Hubert, I. Iordanoff
//
// This program 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.
//
// 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
#ifndef _libDEM_Tool_tpp_
#define _libDEM_Tool_tpp_
 
#include <string>
 
#include "GranOO3/Core/SetOf.hpp"
#include "GranOO3/Core/Base.hpp"
 
#include "GranOO3/DEM/ExtendedSetOf/Tool.hpp"
#include "GranOO3/DEM/Element.hpp"
#include "GranOO3/Physic/Body.hpp"
#include "GranOO3/Shape/Volume.hpp"
#include "GranOO3/Core/XmlParser.hpp"
 
 
namespace GranOO3
{
  namespace DEM
  {
 
    class Tool : public Physic::Body,
         public Core::Register<Tool>
    {
 
      GRANOO_CLASS(DEM::Tool, Physic::Body);
      GRANOO_CLASS_DEFAULT_COLOR(.235, .729, .918, 1.);
 
    public:
      static Tool& get(const std::string& ID);
      static bool exist(const std::string& ID);
      static Tool& glob(const std::string& ID);
      static Tool* new_object(const TiXmlElement* el);
 
    public:
      //CONSTRUCTORS & DESTRUCTORS
      Tool(Shape::Volume& shape, const std::string& ID, const Geom::Point& p, const Geom::Quaternion& q, double mass,
       const Geom::Tensor& inertia);
      Tool(Shape::Volume& shape);
      virtual ~Tool() = 0;
 
      //INTERNAL USE (Not documented)
      virtual void read_xml_element(const TiXmlElement* el);
      virtual void add_glob(const std::string&) = 0;
 
      //USEFULL
      virtual void draw() = 0;
      virtual std::string info() const;
      virtual std::string shape_class_ID() const = 0;
 
 
      //ACCESSORS
      GRANOO_ACCESS(ID, std::string, _ID);
 
      // IO
      virtual std::ostream& write_ascii(std::ostream& out) const;
      virtual std::istream& read_ascii(std::istream& in);
      virtual std::ostream& write_ascii_shape(std::ostream& out) const = 0; // for .agdd compatibility
      virtual std::istream& read_ascii_shape(std::istream& in) = 0;         // for .agdd compatibility
 
    private:
      Tool(const Tool  &) = delete;              // Not allowed
      Tool  & operator=(const Tool  &) = delete; // Not allowed
 
      //SERIALIZATION
      friend class boost::serialization::access;
      template<class Archive> void save(Archive&, const unsigned int ) const;
      template<class Archive> void load(Archive&, const unsigned int);
      BOOST_SERIALIZATION_SPLIT_MEMBER();
 
    protected:
      Tool();
 
    private:
      std::string _ID;
    };
 
 
    inline bool
    Tool::exist(const std::string& id) {
      Core::SetOf<Tool> &toolsSet = Core::SetOf<Tool>::get_global_set();
      for (auto &aTool : toolsSet) {
        if (aTool->get_ID() == id)
          return true;
      }
 
      return false;
    }
 
    inline Tool&
    Tool::get(const std::string& id) {
      Core::SetOf< Tool >& set = Core::SetOf< Tool >::get_global_set();
      for (unsigned int i = 0; i<set.size(); ++i) {
        if (set[i]->get_ID()==id)
          return *set[i];
      }
      UserAssert(0, "can't find Tool named " + id);
      return *set[0];
    }
 
    inline std::string
    Tool::info() const {
      std::ostringstream os;
      os << Body::info() << "User Id : " << _ID << '\n';
      return os.str();
    }
 
    template<class Archive> void
    Tool::save(Archive& ar, const unsigned int) const {
      ar << boost::serialization::base_object<Physic::Body>(*this);
      ar << _ID;
    }
 
    template<class Archive> void
    Tool::load(Archive& ar, const unsigned int) {
      ar >> boost::serialization::base_object<Physic::Body>(*this);
      ar >> _ID;
 
      local_frame().update_glMatrix();
      _ID = Core::SetOfManager::get().get_SerializationPrefix() + _ID +
            Core::SetOfManager::get().get_SerializationSuffix();
    }
 
  }
}
 
namespace GranOO3
{
  GRANOO_CLASS_DECLARE_TPL(DEM::Tool);
}
 
 
 
#endif