i_occurrence.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2014-05-11
 * Last modified : 2014-08-10
 *
 * Copyright (C) 2014 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   Some utilities for the description of configuration variants and parameters.
 *
 */

#ifndef DATATOOLS_CONFIGURATION_I_OCCURRENCE_H
#define DATATOOLS_CONFIGURATION_I_OCCURRENCE_H

// Standard library:
#include <string>
#include <vector>

// Third party:
// - Boost:
#include <boost/cstdint.hpp>

namespace datatools {

  namespace configuration {

    // Forward declaration:
    class single_occurrence;

    class i_occurrence
    {
    public:

      static const int INVALID_ID = -2;
      static const int SINGLE_ID  = -1;

      i_occurrence();

      virtual ~i_occurrence();

      virtual size_t get_dimension() const = 0;

      virtual size_t get_number_of_occurrences() const = 0;

      virtual void compute_occurrence(int rank_, single_occurrence & occ_) const = 0;

      bool is_multiple() const;

      single_occurrence get_occurrence_by_rank(int rank_) const;

      virtual size_t compute_index_path(std::vector<uint32_t> & path_, int rank_) const = 0;

      virtual std::string to_string() const = 0;

    };

  }  // end of namespace configuration

}  // end of namespace datatools

#endif // DATATOOLS_CONFIGURATION_I_OCCURRENCE_H

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