TYSpectre.h

Go to the documentation of this file.

/*
 * Copyright (C) <2012> <EDF-R&D> <FRANCE>
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
/*
 *
 */
 
#ifndef __TY_SPECTRE__
#define __TY_SPECTRE__
 
#include "Tympan/models/business/TYElement.h"
#include "Tympan/models/common/spectre.h"
 
typedef OTabFreq TYTabFreq;
 
class TYSpectre : public TYElement, public OSpectre
{
 
    OPROTODECL(TYSpectre)
    TY_EXTENSION_DECL_ONLY(TYSpectre)
 
    // Methodes
public:
    TYSpectre(const double& defaultValue = TY_SPECTRE_DEFAULT_VALUE);
 
    TYSpectre(const OSpectre& spectre);
 
    TYSpectre(OSpectreAbstract& spectreAbstract);
 
    TYSpectre(const OSpectreComplex& spectre);
 
    TYSpectre(const TYSpectre& other);
 
    virtual ~TYSpectre();
 
    virtual TYSpectre& operator=(const TYSpectre& other);
 
    virtual TYSpectre& operator=(const OSpectre& other);
 
    virtual TYSpectre& operator=(const OSpectreAbstract& other);
 
    virtual bool operator==(const TYSpectre& other) const;
 
    virtual bool operator!=(const TYSpectre& otehr) const;
 
    virtual bool deepCopy(const TYElement* pOther, bool copyId = true, bool pUseCopyTag = false);
 
    //  void copyFromStruct(spectre a, MysqlQuery *query);
 
    virtual std::string toString() const;
 
    virtual DOM_Element toXML(DOM_Element& domElement);
    virtual int fromXML(DOM_Element domElement);
 
    virtual bool toXML(const std::string& sFilePath);
    virtual bool fromXML(const std::string& sFilePath);
 
    virtual std::string toXMLString();
    virtual bool fromXMLString(const std::string& sXMLString);
 
    virtual TYSpectreForm getForm()
    {
        return _form;
    }
    virtual void setForm(const TYSpectreForm& form)
    {
        _form = form;
    }
 
    virtual QString getRemarque() const
    {
        return _remarque;
    }
 
    virtual void setRemarque(QString rq)
    {
        _remarque = rq;
    }
 
    //  bool getKeepInBDD() { return _keepInBDD; }
 
    //  void setKeepInBDD(bool flag) { _keepInBDD = flag; }
 
    virtual bool getIsReadOnly()
    {
        return _isReadOnly;
    }
 
    virtual void setIsReadOnly(bool flag)
    {
        _isReadOnly = flag;
    }
 
    virtual void exportCSV(const std::string& filename);
 
    virtual void exportCSV(std::ofstream& ofs);
 
    static TYSpectre getEmptyLinSpectre(const double& valInit = 1.0E-20);
 
    static TYSpectre pondA();
 
    static TYSpectre pondB();
 
    static TYSpectre pondC();
 
    static TYSpectre getLambda(const double& c);
 
    // ======= METHODES STATIQUES
 
    static void setXMLPrecision(const int precision = 2)
    {
        _XMLprecision = precision;
    }
 
    static int getXMLPrecision()
    {
        return _XMLprecision;
    }
 
    static const TYTabFreq getTabFreqNorm(TYSpectreForm form = SPECTRE_FORM_TIERS);
 
    static const float getFreqNorm(int freqIndex);
 
    OSpectre* downcast_ospectre()
    {
        return dynamic_cast<OSpectre*>(this);
    }
    // Membres
public:
protected:
    // ==== MEMBRES STATIQUES
 
    static int _XMLprecision;
 
    bool _isReadOnly;
 
    QString _remarque;
};
 
#endif // __TY_SPECTRE__