SimulationXmlParameter.h

/*************************************************************************
 *   Copyright (C) 2007 by Oliver Bock                                   *
 *   bock@tfh-berlin.de                                                  *
 *                                                                       *
 *   This file is part of Fidelity.                                      *
 *                                                                       *
 *   Fidelity 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, version 3 of the License.          *
 *                                                                       *
 *   Fidelity 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 Fidelity. If not, see <http://www.gnu.org/licenses/>.    *
 *                                                                       *
 *************************************************************************/

#ifndef SIMULATIONXMLPARAMETER_H
#define SIMULATIONXMLPARAMETER_H

#include <QString>

namespace Fidelity {
	namespace Engine {

/**
 * @author Oliver Bock <bock@tfh-berlin.de>
 *
 * This is used by SimulationXmlReader to store and transmit <code>parameter</code> XML objects.
 * The structure of this type is defined by the FSX file format.
 * @todo Future versions might derive the actual <code>parameter</code> tag of the FSX file format from this type.
 * @sa SimulationXmlReader
 */
class SimulationXmlParameter
{

public:
	/**
	 * Empty Constructor
	 */
	SimulationXmlParameter();

	/**
	 * Get the value of m_Identifier.
	 * @return The value of m_Identifier.
	 * @sa m_Identifier
	 */
	QString Identifier() const;

	/**
	 * Set the value of m_Identifier.
	 * @param value The new value of m_Identifier.
	 * @sa m_Identifier
	 */
	void setIdentifier(const QString value);

	/**
	 * Get the value of m_Unit.
	 * @return The value of m_Unit.
	 * @sa m_Unit
	 */
	QString Unit() const;

	/**
	 * Set the value of m_Unit.
	 * @param value The new value of m_Unit.
	 * @sa m_Unit
	 */
	void setUnit(const QString value);

	/**
	 * Get the value of m_DataType.
	 * @return The value of m_DataType.
	 * @sa m_DataType
	 */
	QString DataType() const;

	/**
	 * Set the value of m_DataType.
	 * @param value The new value of m_DataType.
	 * @sa m_DataType
	 */
	void setDataType(const QString value);

	/**
	 * Get the value of m_Value.
	 * @return The value of m_Value.
	 * @sa m_Value
	 */
	QString Value() const;

	/**
	 * Set the value of m_Value.
	 * @param value The new value of m_Value.
	 * @sa m_Value
	 */
	void setValue(const QString value);

private:
	/**
	 * This member stores the identifier of the parameter.<br>
	 * It is also part of Fidelity::Plugin::Component::Base::AParameter.
	 * @sa Identifier
	 * @sa setIdentifier
	 * @sa Fidelity::Plugin::Component::Base::AParameter
	 */
	QString m_Identifier;

	/**
	 * This member stores the unit of the parameter.<br>
	 * It is also part of Fidelity::Plugin::Component::Base::AParameter.
	 * @sa Unit
	 * @sa setUnit
	 * @sa Fidelity::Plugin::Component::Base::AParameter
	 */
	QString m_Unit;

	/**
	 * This member stores the data type of the parameter.<br>
	 * It is also part of Fidelity::Plugin::Component::Base::ParameterHandler.
	 * @sa DataType
	 * @sa setDataType
	 * @sa Fidelity::Plugin::Component::Base::ParameterHandler
	 */
	QString m_DataType;

	/**
	 * This member stores the value of the parameter.<br>
	 * It is also part of Fidelity::Plugin::Component::Base::Parameter.
	 * @sa Value
	 * @sa setValue
	 * @sa Fidelity::Plugin::Component::Base::Parameter
	 */
	QString m_Value;
};}}

#endif