FMTFork.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 FMTFORK_Hm_included
#define FMTFORK_Hm_included
 
#include "FMTTransitionMask.h"
#include "FMTBounds.hpp"
#include <vector>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/split_member.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/export.hpp>
#include <boost/serialization/unique_ptr.hpp>
#include <boost/serialization/vector.hpp>
#include "FMTObject.h"
 
namespace Core
{
 
class FMTDevelopment;
class FMTDevelopmentPath;
class FMTYieldRequest;
class FMTYields;
class FMTTheme;
class FMTMaskFilter;
 
 
// DocString: FMTFork
class FMTEXPORT FMTFork : public FMTSpec, public FMTObject
    {
    public:
        // DocString: FMTFork()
        FMTFork();
        // DocString: FMTFork(const FMTFork&)
        FMTFork(const FMTFork& rhs)=default;
        // DocString: ~FMTFork()
        ~FMTFork();
        // DocString: FMTFork::operator=
        FMTFork& operator = (const FMTFork& rhs)=default;
        // DocString: FMTFork::add
        void add(const FMTTransitionMask& transition);
        // DocString: FMTFork::clear
        void clear();
        // DocString: FMTFork::getPaths
        std::vector<FMTDevelopmentPath> getPaths(const Core::FMTDevelopment& base, const Core::FMTYields& ylds,
                const std::vector<FMTTheme>& themes,const bool& reset_age) const;
        // DocString: FMTFork::getMax
        FMTDevelopment getMax(const FMTDevelopment& base,const FMTYields& ylds,const std::vector<FMTTheme>& themes, const bool& reset_age) const;
        // DocString: FMTFork::getMaskTrans
        std::vector<FMTTransitionMask> getMaskTrans() const;
        // DocString: FMTFork::operator==
        bool operator == (const FMTFork& rhs) const;
        // DocString: FMTFork::single
        FMTFork single() const;
        // DocString: FMTFork::sumProp
        double sumProp() const;
        // DocString: FMTFork::size
        size_t size() const;
        // DocString: FMTFork::preSolve
        FMTFork preSolve(const FMTMaskFilter& filter, const std::vector<FMTTheme>&presolvedthemes) const;
        // DocString: FMTFork::preSolveRef
        void preSolveRef(const FMTMaskFilter& filter, const std::vector<FMTTheme>& presolvedthemes);
        // DocString: FMTFork::operator std::string
        operator std::string() const override;
    private:
        friend class boost::serialization::access;
        // DocString: FMTFork::serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar& boost::serialization::make_nvp("specifications", boost::serialization::base_object<FMTSpec>(*this));
            ar& m_transitions;
        }
        std::vector<FMTTransitionMask>m_transitions;
        // DocString: FMTFork::_getPath
        FMTDevelopmentPath _getPath(const FMTTransitionMask& p_target,
            const Core::FMTDevelopment& p_base, const Core::FMTYields& p_yields,
            const std::vector<FMTTheme>& p_themes, bool p_AgeReset) const;
    };
 
}
 
BOOST_CLASS_EXPORT_KEY(Core::FMTFork)
 
#endif // FMTFORK_Hm_included