data_description.h

Go to the documentation of this file.

//
// Copyright (c) 2015 by François Mauger <mauger@lpccaen.in2p3.fr>
//
// This file is part of Datatools.
//
// Datatools 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.
//
// Datatools 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 Datatools. If not, see <http://www.gnu.org/licenses/>.

#ifndef DATATOOLS_INTROSPECTION_DATA_DESCRIPTION_H
#define DATATOOLS_INTROSPECTION_DATA_DESCRIPTION_H

// Third party:
// - Boost:
#include <boost/optional.hpp>
// - Bayeux/datatools:
#include <datatools/properties.h>

// This project:
#include <datatools/introspection/data_type.h>
#include <datatools/introspection/data_layout.h>
#include <datatools/introspection/unit_support.h>

namespace datatools {

  namespace introspection {

    class data_description
      : public datatools::i_tree_dumpable
    {
    public:

      data_description();

      ~data_description();

      bool has_type() const;

      data_type get_type() const;

      void set_type(data_type);

      const std::type_info & native_type() const;

      bool has_layout() const;

      data_layout get_layout() const;

      std::string get_layout_label() const;

      void set_layout(data_layout);

      bool has_vector_fixed_size() const;

      std::size_t get_vector_fixed_size() const;

      void set_vector_fixed_size(std::size_t);

      void reset_vector_fixed_size();

      bool has_unit_info() const;

      bool has_unit_support() const;

      const unit_info & get_unit_info() const;

      void set_unit_info(const unit_info & ui_);

      void reset_unit_info();

      bool is_dimensionless() const;

      bool has_implicit_unit() const;

      const std::string & get_implicit_unit_symbol() const;

      bool has_explicit_unit_dimension() const;

      const std::string & get_explicit_unit_dimension_label() const;

      bool has_preferred_unit() const;

      const std::string & get_preferred_unit_symbol() const;

      std::string get_unit_dimension_label() const;

      bool has_type_id() const;

      const std::string & get_type_id() const;

      void set_type_id(const std::string &);

      void reset_type_id();

      bool is_valid() const;

      void initialize();


      void initialize(const datatools::properties &);

      void reset();

      enum dd_xc_flags {
        DD_XC_CLEAR              = bit_mask::bit00,
        DD_XC_TYPE               = bit_mask::bit01,
        DD_XC_LAYOUT             = bit_mask::bit02,
        DD_XC_VECTOR_FIXED_SIZE  = bit_mask::bit03,
        DD_XC_UNIT_INFO          = bit_mask::bit04,
        DD_XC_TYPE_ID            = bit_mask::bit05,
        DD_XC_DEFAULT = (DD_XC_CLEAR
                         | DD_XC_TYPE
                         | DD_XC_LAYOUT
                         | DD_XC_VECTOR_FIXED_SIZE
                         | DD_XC_UNIT_INFO
                         | DD_XC_TYPE_ID),
        DD_XC_LAST    = DD_XC_TYPE_ID
      };

      void export_to_config(datatools::properties & config_,
                            uint32_t flags_ = DD_XC_DEFAULT,
                            const std::string & prefix_ = "") const;

      virtual void tree_dump(std::ostream & out_ = std::clog,
                             const std::string & title_  = "",
                             const std::string & indent_ = "",
                             bool inherit_ = false) const;

      void make_scalar(data_type, const std::string & info_ = "", const std::string & info2_ = "");

      void make_fixed_size_vector(data_type, std::size_t size_, const std::string & info_ = "", const std::string & info2_ = "");

      void make_free_size_vector(data_type, const std::string & info_ = "", const std::string & info2_ = "");

    private:

      void _set_defaults();

      void _make_unit(const std::string & utoken_ = "", const std::string & utoken2_ = "");

    private:

      data_type   _type_;   
      data_layout _layout_; 
      boost::optional<std::size_t> _vector_fixed_size_; 
      boost::optional<unit_info>   _unit_info_; 
      boost::optional<std::string> _type_id_; 
      // type restriction

    };

  } // namespace introspection

} // namespace datatools

#endif // DATATOOLS_INTROSPECTION_DATA_DESCRIPTION_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --