omgalgorithm.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 OMGALGORITHM_H
#define OMGALGORITHM_H

#include <omgguid.h>
#include <omgalgorithmparameter.h>
#include "omgserialisable.h"

#include <QString>
#include <QVector>

class OMG_LIB_EXPORT OmgAlgorithm : public OmgSerialisable, public OmgGuid
{
public:
  OmgAlgorithm();
  ~OmgAlgorithm();
  enum Origin {ADAPTERPROFILE=100,USERPROFILE=200,UNDEFINED=300};

  //ancilliary helpers
  QString toHtml() const;
  int parameterCount();
  
  //
  //serialisable interface
  //
  
  QString toXml() const;
  bool fromXml(const QString theXml) ;

  QString toModelCreationXml() const;
  QString toModelProjectionXml(QString theModel, QString theNormalization="") const;

  QString toString() const;
  //mutators

  void setId(QString theId);
  void setName(QString theName);
  void setAuthor(QString theAuthor);
  void setCodeAuthor(QString theCodeAuthor);
  void setContact(QString theContact);
  void setVersion(QString theVersion);
  void setCategorical(int theCategorical);
  void setAbsence(int theAbsence);
  void setOverview(QString theOverview);
  void setDescription(QString theDescription);
  void setBibliography(QString theBibliography);
  void setParameters(QVector<OmgAlgorithmParameter> theParameters);
  void addParameter(OmgAlgorithmParameter theParameter);
  void setOrigin(Origin theOrigin);
  //accessors

  QString id();
  QString name() const;
  QString author();
  QString contact();
  QString codeAuthor();
  QString version();
  int categorical();
  int absence();
  QString overview();
  QString description();
  QString bibliography();
  QVector<OmgAlgorithmParameter> parameters();
  OmgAlgorithmParameter parameter(QString theId);
  Origin origin();
private:

  QString mId;
  QString mName;
  QString mAuthor;
  QString mCodeAuthor;
  QString mContact;
  QString mVersion;
  int mCategorical;
  int mAbsence;
  QString mOverview;
  QString mDescription;
  QString mBibliography;
  QVector<OmgAlgorithmParameter> mParameters;
  Origin mOrigin;

};

#endif //OMGALGORITHM_H

---