TYChemin.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_CHEMIN_9613__
#define __TY_CHEMIN_9613__
 
#include <deque>
#include "TYEtape.h"
#include "Tympan/models/common/atmospheric_conditions.h"
#include "Tympan/models/common/acoustic_path.h"
 
enum class TYTypeChemin
{
    CHEMIN_DIRECT,
    CHEMIN_SOL,
    CHEMIN_ECRAN,
    CHEMIN_REFLEX
};
 
::std::ostream& operator<<(::std::ostream& out, const TYTypeChemin& value);
 
enum class TYTypeAttenuation
{
    DIRECTIVITY_INDEX,
    ATTENUATION_ATM,
    ATTENUATION_GND_S,
    ATTENUATION_GND_R,
    ATTENUATION_GND_M,
    DZ_TOP,
    DZ_LEFT,
    DZ_RIGHT,
    ATTENUATION_BAR_TOP,
    ATTENUATION_BAR_LEFT,
    ATTENUATION_BAR_RIGHT,
    ATTENUATION_BAR,
    ATTENUATION_REFLEX
};
 
struct TYAttenuation
{
    TYTypeAttenuation type;
    OSpectreOctave attenuation;
};
 
class TYChemin
{
    // Methods
public:
    TYChemin();
    TYChemin(const TYChemin& other);
    virtual ~TYChemin();
 
    TYChemin& operator=(const TYChemin& other);
    bool operator==(const TYChemin& other) const;
    bool operator!=(const TYChemin& other) const;
 
    void calcAttenuation(const TYTabEtape& tabEtapes, const AtmosphericConditions& atmos, double dp = 0.0,
                         double hs = 0.0, double hr = 0.0, double Gs = 0.5, double Gm = 0.5, double Gr = 0.5);
 
    void computeBarAttenuation(const OSpectreOctave& Dz, const bool vertical, const bool left);
 
    OSpectreOctave& getAttenuation(TYTypeAttenuation type);
 
    // const OSpectreOctave& getAttenuation(TYTypeAttenuation type) const
    // {
    //     return _attenuations[type];
    //}
 
    // Kept for compatibility
    // TODO delete when 9613 is over
    OSpectreOctave& getAttenuation()
    {
        return _attenuation;
    }
 
    const OSpectreOctave& getAttenuation() const
    {
        return _attenuation;
    }
 
    void setAttenuation(const TYTypeAttenuation& type, const OSpectreOctave& att)
    {
        _attenuations[type] = att;
    }
 
    void setAttenuationBarWhenNoPath(bool vertical, bool left);
 
    double getLongueur()
    {
        return _longueur;
    }
    const double getLongueur() const
    {
        return _longueur;
    }
 
    void setLongueur(const double& longueur)
    {
        _longueur = longueur;
    }
 
    double getDistance()
    {
        return _distance;
    }
    const double getDistance() const
    {
        return _distance;
    }
 
    void setDistance(const double& distance)
    {
        _distance = distance;
    }
 
    void setType(const TYTypeChemin& type)
    {
        _typeChemin = type;
    }
 
    const TYTypeChemin getType() const
    {
        return _typeChemin;
    }
    // Members
    void build_eq_path(const TYTabEtape& tabEtapes);
    acoustic_path* get_ray(OPoint3D ptR);
 
protected:
    TYTypeChemin _typeChemin;
 
    double _longueur;
 
    double _distance;
 
    std::map<TYTypeAttenuation, OSpectreOctave> _attenuations;
 
    // Kept for compatibility
    // TODO delete when 9613 is over
    OSpectreOctave _attenuation;
 
    acoustic_path* _eq_path;
 
private:
    void calcGroundAttenuations(double distance, double hs, double hr, double Gs, double Gm, double Gr);
    OSpectreOctave calcGroundAttenuationSR(double dp, double h, double G);
    OSpectreOctave calcGroundAttenuationM(double q, double Gm);
};
 
typedef std::deque<TYChemin> TYTabChemin;
 
#endif // __TY_CHEMIN_9613__