TYChemin.h

Go to the documentation of this file.

/*
 * Copyright (C) <2012-2024> <EDF-DTG> <FRANCE>
 * This file is part of Code_TYMPAN (R).
 * Code_TYMPAN (R) 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 3 of the License, or
 * (at your option) any later version.
 * Code_TYMPAN (R) 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 Code_TYMPAN (R). If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef __TY_CHEMIN__
#define __TY_CHEMIN__
 
#include "Tympan/solvers/9613/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,
    ATTENUATION_GND_TOTAL,
    REFLEXION_MIN_EXT_COND
};
 
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;
 
    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
    template <typename T> void build_eq_path(const T& tabEtapes)
    {
        for (size_t i = 0; i < tabEtapes.size(); i++)
        {
            _eq_path->addEvent(tabEtapes[i].asEvent());
        }
    }
 
    acoustic_path* get_ray(OPoint3D ptR);
 
protected:
    TYTypeChemin _typeChemin;
 
    double _longueur;
 
    double _distance;
 
    acoustic_path* _eq_path;
 
private:
};
 
typedef std::deque<TYChemin> TYTabChemin;
 
#endif // __TY_CHEMIN__