DatastoreDescriptor.hpp

Go to the documentation of this file.

/*

  This file is part of OpenFLUID software
  Copyright(c) 2007, INRA - Montpellier SupAgro


 == 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 Aline LIBRES <libres@supagro.inra.fr>
 */


#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();

    ~DatastoreDescriptor();

    DatastoreDescription_t& items();

    const DatastoreDescription_t& items() const;

    bool appendItem(DatastoreItemDescriptor* Item);

    bool isItemIDAlreadyExist(const std::string& ItemID) const;

};


} }  // namespaces


#endif /* __OPENFLUID_FLUIDX_DATASTOREDESCRIPTOR_HPP__ */