DatastoreDescriptor.hpp

Go to the documentation of this file.

/*
 
  This file is part of OpenFLUID software
  Copyright(c) 2021-2026, INRAE
 
 
 == GNU General Public License Usage ==
 
  OpenFLUID 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.
 
  OpenFLUID 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 OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
 
 
 == Other Usage ==
 
  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/
 
 
/**
  @file DatastoreDescriptor.hpp
 
  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
  @author Aline LIBRES <aline.libres@gmail.com>
*/
 
 
#ifndef __OPENFLUID_FLUIDX_DATASTOREDESCRIPTOR_HPP__
#define __OPENFLUID_FLUIDX_DATASTOREDESCRIPTOR_HPP__
 
 
#include <list>
 
#include <openfluid/dllexport.hpp>
#include <openfluid/fluidx/DatastoreItemDescriptor.hpp>
 
 
namespace openfluid { namespace fluidx {
 
 
class OPENFLUID_API DatastoreDescriptor
{
  public:
 
    typedef std::list<DatastoreItemDescriptor*> DatastoreDescription_t;
 
 
  private:
 
    DatastoreDescription_t m_DatastoreDescription;
 
 
  public:
 
    DatastoreDescriptor() = default;
 
    ~DatastoreDescriptor()
    { }
 
    DatastoreDescription_t& items();
 
    const DatastoreDescription_t& items() const;
 
    bool appendItem(DatastoreItemDescriptor* Item);
 
    bool isItemExist(const std::string& ItemID) const;
 
    DatastoreDescription_t getItems(const openfluid::core::UnitsClass_t& UnitClass) const;
 
    DatastoreDescription_t getItems(const openfluid::core::UnitsClass_t& UnitClass,
                                    openfluid::core::UnstructuredValue::UnstructuredType Type) const;
 
    /**
      Move the Item located at the given From position to the To position (positions starts at index 0)
      @param From
      @param To
      @throw openfluid::base::FrameworkException a position is out of range
    */
    void moveItem(unsigned int From, unsigned int To);
 
    /**
     Insert an Item before the given position (positions starts at index 0)
     @param[in] Item the DatastoreItemDescriptor to insert
     @param[in] Position the position, should be between zero and list size - 1.
     To insert an Item at the end of the list, use appendItem instead.
     @throw openfluid::base::FrameworkException if Position is out of range
    */
    void insertItem(openfluid::fluidx::DatastoreItemDescriptor* Item, unsigned int Position);
 
    /**
     Remove from the list the Item located at the given Position (positions starts at index 0).
     This doesn't delete the DatastoreItemDescriptor pointer.
     @param[in] Position the position
     @throw openfluid::base::FrameworkException if Position is out of range
    */
    void removeItem(unsigned int Position);
 
    std::list<std::string> getItemsIDs() const;
 
    /**
      @brief Gets the item of the datastore matching the given ID.
 
      @param ItemID ID of the expected item.
      @return The item with the given ID, or 0 if not found.
    */
    openfluid::fluidx::DatastoreItemDescriptor* item(const std::string& ItemID);
 
};
 
 
} }  // namespaces
 
 
#endif /* __OPENFLUID_FLUIDX_DATASTOREDESCRIPTOR_HPP__ */