FMTSchedule.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 FMTschedule_Hm_included
#define FMTschedule_Hm_included
 
#include <map>
#include <vector>
#include "FMTDevelopment.h"
#include "FMTAction.h"
#include "FMTObject.h"
#include <iterator>
#include <boost/serialization/export.hpp>
#include <boost/unordered_set.hpp>
 
namespace Core
{
class FMTConstraint;
// DocString: FMTSchedule
class FMTEXPORT FMTSchedule : public FMTObject
    {
    public:
        // DocString: FMTSchedule(const int&)
        FMTSchedule(const int& lperiod, const FMTObject& obj, const bool& luselock);
        // DocString: FMTSchedule(const int&,std::vector<FMTSchedule>&)
        FMTSchedule(const int& lperiod, std::vector<FMTSchedule>& schedules);
        // DocString: FMTSchedule(int,std::map<FMTAction,std::map<FMTDevelopment,std::vector<double>>>)
        FMTSchedule(int lperiod, std::map<FMTAction, std::map<FMTDevelopment, std::vector<double>>> mapping);
        // DocString: FMTSchedule(int,const std::map<FMTAction,std::map<FMTDevelopment,std::map<int,double>>>&)
        FMTSchedule(int lperiod, const std::map<FMTAction, std::map<FMTDevelopment, std::map<int,double>>>& mapping);
        // DocString: FMTSchedule()
        FMTSchedule();
        // DocString: ~FMTSchedule()
        ~FMTSchedule() = default;
        // DocString: FMTSchedule(const FMTSchedule&)
        FMTSchedule(const FMTSchedule& rhs);
        // DocString: FMTSchedule::operator=
        FMTSchedule& operator = (const FMTSchedule& rhs);
        // DocString: FMTSchedule::operator==
        bool operator == (const FMTSchedule& rhs) const;
        // DocString: FMTSchedule::operator!=
        bool operator != (const FMTSchedule& rhs) const;
        // DocString: FMTSchedule::operator+=
        FMTSchedule& operator += (const FMTSchedule& rhs);
        // DocString: FMTSchedule::operator+
        FMTSchedule operator + (const FMTSchedule& rhs) const;
        // DocString: FMTSchedule::operator std::string
        operator std::string() const;
        // DocString: FMTSchedule::getPeriod
        inline int getPeriod() const
            {
            return m_period;
            }
        // DocString: FMTSchedule::doUseLock
        inline bool doUseLock() const
        {
            return m_uselock;
        }
        // DocString: FMTSchedule::setUseLock
        void setUseLock(const bool& lock);
        // DocString: FMTSchedule::actionArea
        double actionArea(const FMTAction& action) const;
        // DocString: FMTSchedule::addEvent
        void addEvent(const Core::FMTDevelopment& dev, const double& area, const Core::FMTAction& action);
        // DocString: FMTSchedule::clean
        void clean();
        // DocString: FMTSchedule::area
        double area() const;
        // DocString: FMTSchedule::operated
        bool operated(const FMTAction& action,
            const FMTDevelopment& development) const;
        // DocString: FMTSchedule::getOperabilities
        std::vector<boost::unordered_set<FMTDevelopment>> getOperabilities(const std::vector<FMTAction>& actions) const;
        // DocString: FMTSchedule::sort
        void sort();
        // DocString: FMTSchedule::empty
        bool empty() const;
        // DocString: FMTSchedule::size
        size_t size() const;
        // DocString: FMTSchedule::preSolve
        FMTSchedule preSolve(const FMTMaskFilter& filter,
            const std::vector<FMTTheme>& newthemes, const std::vector<FMTAction>&presolvedaction) const;
        // DocString: FMTSchedule::postSolve
        FMTSchedule postSolve(const FMTMaskFilter& filter,
            const std::vector<FMTTheme>& originalbasethemes, const std::vector<FMTAction>&originalbasebaseactions) const;
        // DocString: FMTSchedule::setPeriod
        void setPeriod(const int& newPeriod);
        // DocString: FMTSchedule::getNewSchedule
        FMTSchedule getNewSchedule(const double& factor) const;
        // DocString: FMTSchedule::isFuturConstraints
        bool isFuturConstraints(const std::vector<Core::FMTConstraint>& constraints) const;
        typedef typename std::map<FMTAction, std::map<FMTDevelopment, std::vector<double>>>::value_type value_type;
        typedef typename std::map<FMTAction, std::map<FMTDevelopment, std::vector<double>>>::iterator iterator;
        typedef typename std::map<FMTAction, std::map<FMTDevelopment, std::vector<double>>>::const_iterator const_iterator;
        // DocString: FMTSchedule::operator[]
        std::map<FMTDevelopment, std::vector<double>>& operator[](const FMTAction& action);
        // DocString: FMTSchedule::at
        const std::map<FMTDevelopment, std::vector<double>>& at(const FMTAction& action) const;
        // DocString: FMTSchedule::find
        iterator find(const FMTAction& actionkey);
        // DocString: FMTSchedule::find() const
        const_iterator find(const FMTAction& actionkey) const;
        // DocString: FMTSchedule::begin
        iterator begin();
        // DocString: FMTSchedule::begin() const
        const_iterator begin() const;
        // DocString: FMTSchedule::end
        iterator  end();
        // DocString: FMTSchedule::end() const
        const_iterator end() const;
    private:
        // DocString: FMTSchedule::serialize
        friend class boost::serialization::access;
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            try {
                ar& boost::serialization::make_nvp("FMTobject", boost::serialization::base_object<FMTObject>(*this));
                ar& boost::serialization::make_nvp("period", m_period);
                ar& boost::serialization::make_nvp("elements", m_elements);
            }
            catch (...)
            {
                _exhandler->printExceptions("", "FMTSchedule::serialize", __LINE__, __FILE__);
            }
        }
        // DocString: FMTSchedule::m_period
        int m_period;
        // DocString: FMTSchedule::m_uselock
        bool m_uselock;
        // DocString: FMTSchedule::m_elements
        std::map<FMTAction, std::map<FMTDevelopment, std::vector<double>>> m_elements;
        // DocString: FMTSchedule::_sameElements
        bool _sameElements(const FMTSchedule& rhs) const;
    };
 
 
}
BOOST_CLASS_EXPORT_KEY(Core::FMTSchedule)
#endif // FMTschedule_Hm_included