FMTVirtualLineGraph.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 FMTVIRTUALLINEGRAPH_H
#define FMTVIRTUALLINEGRAPH_H
 
 
#include "FMTutility.h"
#include <vector>
#include <map>
#include <memory>
#include "FMTGraphInfo.h"
#include "FMTSpatialGraphs.h"
 
namespace Graph
{
    class FMTLineGraph;
}
 
namespace Models
{
    class FMTModel;
}
 
namespace Core
{
    class FMTOutput;
    class FMTTheme;
    class FMTMaskFilter;
}
 
 
namespace Spatial
    {
    template <typename T>
    class FMTLayer;
    class FMTSolutionTracker;
    // DocString: FMTVirtualLineGraph
    class FMTEXPORT FMTVirtualLineGraph
        {
        public:
            // DocString: FMTVirtualLineGraph()
            FMTVirtualLineGraph()=default;
            // DocString: FMTVirtualLineGraph(FMTSpatialGraphs&,FMTSpatialGraphs::const_iterator,size_t)
            FMTVirtualLineGraph(FMTSpatialGraphs& p_Graphs,
                            FMTSpatialGraphs::const_iterator p_Iterator,
                            size_t p_Family);
            // DocString: FMTVirtualLineGraph(const FMTVirtualLineGraph&,FMTSpatialGraphs&)
            FMTVirtualLineGraph(const FMTVirtualLineGraph& p_LineGraph, FMTSpatialGraphs& p_Graphs);
            // DocString: FMTVirtualLineGraph(const FMTVirtualLineGraph&)
            FMTVirtualLineGraph(const FMTVirtualLineGraph& p_LineGraph);
            // DocString: FMTVirtualLineGraph::operator=
            FMTVirtualLineGraph& operator = (const FMTVirtualLineGraph& p_LineGraph);
            // DocString: ~FMTVirtualLineGraph()
            ~FMTVirtualLineGraph();
            // DocString: FMTVirtualLineGraph::operator==
            bool operator == (const  FMTVirtualLineGraph& p_Element) const;
            // DocString: FMTVirtualLineGraph::operator<
            bool operator < (const  FMTVirtualLineGraph& p_Element) const;
            // DocString: FMTVirtualLineGraph::hash
            size_t hash() const;
            // DocString: FMTVirtualLineGraph::getLineGraph
            const Graph::FMTLineGraph& getLineGraph() const;
            // DocString: FMTVirtualLineGraph::setLineGraph
            void setLineGraph(const Graph::FMTLineGraph& p_LineGraph,
                            FMTSolutionTracker& p_solution);
            // DocString: FMTVirtualLineGraph::getOutput
            double getOutput(const Models::FMTModel& p_model,
                const FMTSolutionTracker& p_solution,
                const Core::FMTOutput& p_output, int p_period) const;
            // DocString: FMTVirtualLineGraph::getGraphFamily
            size_t getGraphFamily() const;
            // DocString: FMTVirtualLineGraph::setBaseGraph
            void setBaseGraph(FMTSolutionTracker& p_solution);
            // DocString: FMTVirtualLineGraph::setLastPeriod
            void setLastPeriod(FMTSolutionTracker& p_solution);
            // DocString: FMTVirtualLineGraph::setNaturalGrowth
            void setNaturalGrowth(FMTSolutionTracker& p_solution);
            // DocString: FMTVirtualLineGraph::postSolve
            FMTVirtualLineGraph postSolve(const Core::FMTMaskFilter& p_Filter,
                    const std::vector<int>& p_actionMapping,
                    FMTSpatialGraphs& p_Graphs,
                FMTSolutionTracker& p_solution) const;
        private:
            FMTSpatialGraphs::const_iterator m_Iterator;
            size_t m_GraphFamily;
            FMTSpatialGraphs* m_Graphs;
            // DocString: FMTVirtualLineGraph::_insertInto
            void _insertInto(const Graph::FMTLineGraph& p_LineGraph,
                    FMTSolutionTracker& p_solution);
            // DocString: FMTVirtualLineGraph::_add
            void _add(FMTSolutionTracker& p_solution);
            // DocString: FMTVirtualLineGraph::_remove
            void _remove(FMTSolutionTracker& p_solution);
            // DocString: FMTVirtualLineGraph::notNull
            bool notNull() const;
        };
    }
 
namespace std {
    template <>
    struct hash<Spatial::FMTVirtualLineGraph>
    {
        std::size_t operator()(const Spatial::FMTVirtualLineGraph& p_object) const
        {
            return (p_object.hash());
        }
    };
 
}
 
 
#endif