omgalgorithmparameter.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Tim Sutton   *
 *   tim@linfiniti.com   *
 *                                                                         *
 *   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 2 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.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef OMGALGORITHMPARAMETER_H
#define OMGALGORITHMPARAMETER_H

#include "omgserialisable.h"

#include <QString>

class OMG_LIB_EXPORT OmgAlgorithmParameter : public OmgSerialisable
{
public:
  OmgAlgorithmParameter();
  ~OmgAlgorithmParameter();
  OmgAlgorithmParameter(
    QString theId,
    QString theName,
    QString theDefault,
    QString theOverview,
    QString theDescription,
    QString theMinimum,
    QString theMaximum,
    QString theValue
    );

  //
  //Serialisable interface
  //
  
  QString toXml() const;
  bool fromXml(const QString theXml) ;

  QString toModelCreationXml() const;

  QString toString() const;
  //mutators
  
  void setId(QString theId);
  void setName(QString theName);
  void setType(QString theType);
  void setDefault(QString theDefault);
  void setOverview(QString theOverview);
  void setDescription(QString theDescription);
  void setMinimum(QString theMinimum);
  void setMaximum(QString theMaximum);
  void setValue(QString theValue);


  //accessors
  
  QString id() const;
  QString name() const ;
  QString type() const ;
  QString overview() const ;
  QString defaultValue() const ;
  QString description() const;
  QString minimum() const ;
  QString maximum() const ;
  QString value() const ;
 
private:
  QString mId;
  QString mName;
  QString mType;
  QString mDefault;
  QString mOverview;
  QString mDescription;
  QString mMinimum;
  QString mMaximum;
  QString mValue;
};

#endif //OMGALGORITHMPARAMETER_H

---