omgalgorithmset.h

Go to the documentation of this file.

/***************************************************************************
                          omgalgorithm.h  -  description
                             -------------------
    begin                : March 2006
    copyright            : (C) 2003 by Tim Sutton
    email                : 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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef OMGALGORITHMSET_H
#define OMGALGORITHMSET_H

class QString;
#include <QMap>
#include "omgalgorithm.h"
#include "omgserialisable.h"
class OMG_LIB_EXPORT OmgAlgorithmSet  :  public OmgSerialisable
{
    public:
        OmgAlgorithmSet();
        ~OmgAlgorithmSet();

        bool addAlgorithm(OmgAlgorithm theAlgorithm, bool theOverwriteFlag=false);
        bool removeAlgorithm(OmgAlgorithm theAlgorithm);
        bool removeAlgorithm(QString theAlgorithm);

        static OmgAlgorithmSet getFromActivePlugin();
        //
        // Accessors
        //

        QString name() const;
        QString description() const;
        QStringList nameList();
        //
        // Mutators
        //

        void setName(QString theName);

        void setDescription(QString theDescription);


        //
        // Ancilliary helper methods
        //

              void clear();


        int count() const;
        QString toString();

        QString toXml() const;
        bool fromXml(const QString) ;


        QString toHtml();

        void loadAlgorithms(QString theSearchDir);

        void saveAlgorithms(QString theSaveDir, bool theUserProfilesFlag=true);
        
        OmgAlgorithm getAlgorithm (QString theGuid);

        bool contains(QString theName);
            
        //
        // Overloaded operators
        //

        OmgAlgorithm operator [] (int);
        
    private:
        QString mName;
        QString mDescription;
        typedef QMap<QString,OmgAlgorithm> AlgorithmsMap;
        AlgorithmsMap mAlgorithmsMap;
};

#endif //OMGALGORITHMSET_H

---