fishexample.h

Go to the documentation of this file.

#pragma once

#include "fish/interface/ifishlibrary.h"
using namespace itasca;

class FishExample : public IFishLibrary {
public:
    enum Functions { FreqFunction=0,      
                     AmpFunction,         
                     PhaseFunction,       
                     IntervalFunction,    
                     NumberFunction,      
                     AllFunction,         
                     CreateFunction       
    };

    FishExample(uint id,const QString &name,int numArguments,const QString &returnDescription,
        bool readOnly=true,const QString &argumentDescription=QString::null);
    virtual QStringList createIntrinsics(IFish *fish);
    virtual QStringList createTypes(IFish *,bool) {return QStringList();}
    virtual void        get(IProgram *prog,uint id,const IFishArguments *reg,IFishParam *p);
    virtual void        set(IProgram *prog,uint id,const IFishArguments *reg,const IFishParam *p);

    virtual uint    getID() const { return id_; }
    virtual uint getSubID() const { return 0; }
    virtual QString getName() const { return name_; }
    virtual QString getPluginName() const;
    virtual bool    getReadOnly() const { return readOnly_; }
    virtual int     getNumArguments() const { return numArguments_; }
    virtual QString getReturnDesc() const { return returnDescription_; }
    virtual QString getArgumentDesc() const { return argumentDescription_; }
    virtual bool willSave() const { return getID() ? false : true; }
    virtual void archiveLibrary(IArchive &a);
    virtual void saveLibrary(Archive2 &a) const override;
    virtual bool restoreLibrary(Archive2 &a,quint64 label) override;
    virtual void remapLibrary(Archive2 &a) override;
    virtual void reset();
    virtual void    destroy() { delete this; }
private:
    uint    id_;                   
    QString name_;                 
    int     numArguments_;         
    QString returnDescription_;    
    bool    readOnly_;             
    QString argumentDescription_;  

    static uint     version_;        
    static Double   frequency_;      
    static Double   amplitude_;      
    static Double   phase_;          
    static Double   interval_;       
    static qptrdiff number_;         
};
// EoF