FMTTransitionMask.h

Go to the documentation of this file.

/*
Copyright (c) 2019 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
 
#ifndef FMTMASKTRAN_Hm_included
#define FMTMASKTRAN_Hm_included
 
#include "FMTBounds.hpp"
#include "FMTMask.h"
#include "FMTMaskFilter.h"
#include <boost/serialization/serialization.hpp>
#include <string>
#include <vector>
#include "FMTutility.h"
 
 
 
 
namespace Core
{
class FMTDevelopment;
class FMTDevelopmentPath;
class FMTYields;
class FMTYieldRequest;
class FMTTheme;
 
// DocString: FMTTransitionMask
class FMTEXPORT FMTTransitionMask : public FMTMaskFilter,public FMTSpec
    {
    friend class boost::serialization::access;
    // DocString: FMTTransitionMask::serialize
    template<class Archive>
    void serialize(Archive& ar, const unsigned int version)
    {
        ar & boost::serialization::make_nvp("maskfilter", boost::serialization::base_object<FMTMaskFilter>(*this));
        ar & boost::serialization::make_nvp("specification", boost::serialization::base_object<FMTSpec>(*this));
        ar & BOOST_SERIALIZATION_NVP(mask);
        ar & BOOST_SERIALIZATION_NVP(proportion);
    }
    FMTMask mask;
    double proportion;
        // DocString: FMTTransitionMask::build
        void build(const std::string& lmask,const std::vector<FMTTheme>& themes);
    public:
        // DocString: FMTTransitionMask()
        FMTTransitionMask();
        // DocString: ~FMTTransitionMask()
        ~FMTTransitionMask()=default;
        // DocString: FMTTransitionMask(const std::string&,const std::vector<FMTTheme>&,const double&)
        FMTTransitionMask(const std::string& lmask,const std::vector<FMTTheme>& themes,
                        const double& lproportion);
        // DocString: FMTTransitionMask::trans
        FMTMask trans(const FMTMask& p_baseMask,
                        const std::vector<FMTTheme>& p_themes) const;
        // DocString: FMTTransitionMask(const FMTTransitionMask&)
        FMTTransitionMask(const FMTTransitionMask& rhs);
        // DocString: FMTTransitionMask(const FMTTransitionMask&,const FMTMask&,const std::vector<FMTTheme>&)
        FMTTransitionMask(const FMTTransitionMask& rhs,const FMTMask& lmask,const std::vector<FMTTheme>& themes);
        // DocString: FMTTransitionMask::operator=
        FMTTransitionMask& operator = (const FMTTransitionMask& rhs);
        // DocString: FMTTransitionMask::disturb
        FMTDevelopmentPath disturb(const Core::FMTDevelopment& dev, const FMTYields& yields,
            const std::vector<FMTTheme>& themes,const bool& reset_age) const;
        // DocString: FMTTransitionMask::get
        std::map<std::string, std::string>get(const std::vector<FMTTheme>& themes) const;
        // DocString: FMTTransitionMask::operator==
        bool operator == (const FMTTransitionMask& rhs) const;
        // DocString: FMTTransitionMask::getProportion
        double getProportion() const;
        // DocString: FMTTransitionMask::getMask
        FMTMask getMask() const;
        // DocString: FMTTransitionMask::getMaskReference
        const FMTMask& getMaskReference() const;
        // DocString: FMTTransitionMask::setMask
        void setMask(const Core::FMTMask& mtmask);
        // DocString: FMTTransitionMask::setProportion
        void setProportion(double newproportion);
        // DocString: FMTTransitionMask::preSolve
        FMTTransitionMask preSolve(const FMTMaskFilter& filter, const std::vector<FMTTheme>&presolvedthemes) const;
        // DocString: FMTTransitionMask::preSolveRef
        void preSolveRef(const FMTMaskFilter& filter, const std::vector<FMTTheme>& presolvedthemes);
        // DocString: FMTTransitionMask::operator std::string
        operator std::string() const override;
    };
 
}
#endif // FMTMASKTRAN_Hm_included