core/InputData.hpp

Go to the documentation of this file.

/*
 This file is part of OpenFLUID software
 Copyright (c) 2007-2010 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/>.

 In addition, as a special exception, INRA gives You the additional right
 to dynamically link the code of OpenFLUID with code not covered
 under the GNU General Public License ("Non-GPL Code") and to distribute
 linked combinations including the two, subject to the limitations in this
 paragraph. Non-GPL Code permitted under this exception must only link to
 the code of OpenFLUID dynamically through the OpenFLUID libraries
 interfaces, and only for building OpenFLUID plugins. The files of
 Non-GPL Code may be link to the OpenFLUID libraries without causing the
 resulting work to be covered by the GNU General Public License. You must
 obey the GNU General Public License in all respects for all of the
 OpenFLUID code and other code used in conjunction with OpenFLUID
 except the Non-GPL Code covered by this exception. If you modify
 this OpenFLUID, you may extend this exception to your version of the file,
 but you are not obligated to do so. If you do not wish to provide this
 exception without modification, you must delete this exception statement
 from your version and license this OpenFLUID solely under the GPL without
 exception.


 == 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.
 */

#ifndef __INPUTDATA_H__
#define __INPUTDATA_H__

#include <openfluid/core/TypeDefs.hpp>
#include <openfluid/dllexport.hpp>
#include <openfluid/core/Value.hpp>
#include <openfluid/core/StringValue.hpp>
#include <openfluid/core/IntegerValue.hpp>


namespace openfluid {
namespace core {

class DLLEXPORT InputData
{
  private:

    typedef std::map<InputDataName_t, StringValue> InputDataMap_t;
    InputDataMap_t m_Data;

  public:

    InputData();

    ~InputData();

    bool setValue(const InputDataName_t aName, const Value& aValue);

    bool setValue(const InputDataName_t aName, const std::string& aValue);

    bool getValue(const InputDataName_t aName, openfluid::core::StringValue& aValue) const;

    bool getValue(const InputDataName_t aName, std::string& aValue) const;

    bool getValueAsDouble(const InputDataName_t aName, double& aValue) const;

    bool getValueAsLong(const InputDataName_t aName, long& aValue) const;

    bool isDataExist(const InputDataName_t aName) const;

    std::vector<InputDataName_t> getInputDataNames() const;

    bool replaceValue(const InputDataName_t aName, const StringValue& aValue);

    bool replaceValue(const InputDataName_t aName, const std::string& aValue);

    bool removeData(const InputDataName_t aName);

    void clear();

};


} } // namespaces


#endif /* __INPUTDATA_H__ */