NeedSetOf.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_PlugIn_NeedSetOf_hpp_
#define _libDEM_PlugIn_NeedSetOf_hpp_
 
#include <array>
 
#include "GranOO3/Core/SetOf.hpp"
 
 
namespace GranOO3
{
  namespace Core
  {
    //
    // NeedSetOf  A base class for classes (plugin) which need to read setOf from inp file.
    // ---------  The Number of SetOf wich must be read is set by the template parameter N.
    //
 
 
 
    template<class T, int N = 1>
    class NeedSetOf
    {
 
    public:
      //CONSTRUCTORS & DESTRUCTORS
      NeedSetOf(bool required = true);
      virtual ~NeedSetOf();
 
      //USEFULL
      virtual void parse_xml();
 
      //ACCESSORS
      bool get_required_flag(unsigned int rank = 0) const;
      void set_required_flag(bool flag, unsigned int rank = 0);
      const std::string& get_xml_flag_name(unsigned int rank = 0) const;
      void set_xml_flag_name(const std::string& str, unsigned int rank = 0);
      const std::string& get_xml_flag_nameByRank(unsigned int rank) const;
      void set_xml_flag_name_by_rank(const std::string& str, unsigned int rank);
      bool is_setof_defined(unsigned int rank = 0) const;
 
      // SETOF ACCESS
      Core::SetOf<T>& get_setof(unsigned int rank = 0);
      const Core::SetOf<T>& get_setof(unsigned int rank = 0) const;
      void set_setof(Core::SetOf<T>& set, unsigned int rank = 0);
 
    private:
      std::array<Core::SetOf<T>*, N> _set;
      std::array<bool, N>            _required;
      std::array<std::string, N>     _xmlFlagName;
      std::array<bool, N>            _defined;
 
    };
  }
}
 
 
#include "GranOO3/Core/NeedSetOf.tpp"
 
#endif