FMTBindingSpatialAction.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 FMTBINDINGSPATIALACTION_Hm_included
#define FMTBINDINGSPATIALACTION_Hm_included
 
#include <vector>
#include <limits>
#include <cstddef>
 
namespace Spatial
 
{
    // DocString: FMTBindingSpatialAction
    class FMTBindingSpatialAction
    {
    public:
        // DocString: FMTBindingSpatialAction()
        FMTBindingSpatialAction()=default;
        // DocString: FMTBindingSpatialAction(const FMTBindingSpatialAction)
        FMTBindingSpatialAction(const FMTBindingSpatialAction& rhs) = default;
        // DocString: FMTBindingSpatialAction::operator=
        FMTBindingSpatialAction& operator = (const FMTBindingSpatialAction& rhs)=default;
        // DocString: FMTBindingSpatialAction(const std::vector<int>&,...)
        FMTBindingSpatialAction(const std::vector<int>& lneighbors,
            const size_t& mingreenup, const size_t& maxgreenup,
            const size_t& minadjacency, const size_t& maxadjacency,
            const size_t& minsize, const size_t& maxsize,
            const size_t& minnsize, const size_t& maxnsize);
        // DocString: FMTBindingSpatialAction::isSpatiallyBinding
        bool isSpatiallyBinding() const;
        // DocString: FMTBindingSpatialAction::isSpatiallyAreaBinding
        bool isSpatiallyAreaBinding() const;
        // DocString: FMTBindingSpatialAction::isSpatiallyAdjacencyBinding
        bool isSpatiallyAdjacencyBinding() const;
        // DocString: FMTBindingSpatialAction::testMinimalAdjacency
        bool testMinimalAdjacency() const;
        // DocString: FMTBindingSpatialAction::testMaximalAdjacency
        bool testMaximalAdjacency() const;
        // DocString: FMTBindingSpatialAction::getNeighbors
        inline const std::vector<int>& getNeighbors() const
            {
            return m_neighbors;
            }
        // DocString: FMTBindingSpatialAction::getMinimalGreenUp
        inline const size_t& getMinimalGreenUp() const
            {
            return m_minimal_green_up;
            }
        // DocString: FMTBindingSpatialAction::getMaximalGreenUp
        inline const size_t& getMaximalGreenUp() const
            {
            return m_maximal_green_up;
            }
        // DocString: FMTBindingSpatialAction::getMinimalAdjacency
        inline const size_t& getMinimalAdjacency() const
            {
            return m_minimal_adjacency;
            }
        // DocString: FMTBindingSpatialAction::getMaximalAdjacency
        inline const size_t& getMaximalAdjacency() const
            {
            return m_maximal_adjacency;
            }
        // DocString: FMTBindingSpatialAction::getMinimalSize
        inline const size_t& getMinimalSize() const
            {
            return m_minimal_size;
            }
        // DocString: FMTBindingSpatialAction::getMaximalSize
        inline const size_t& getMaximalSize() const
            {
            return m_maximal_size;
            }
        // DocString: FMTBindingSpatialAction::getMinimalNeighborSize
        inline const size_t& getMinimalNeighborSize() const
            {
            return m_minimal_neighbors_size;
            }
        // DocString: FMTBindingSpatialAction::getMaximalNeighborSize
        inline const size_t& getMaximalNeighborSize() const
            {
            return m_maximal_neighbors_size;
            }
    private:
        std::vector<int>m_neighbors;
        size_t m_minimal_green_up;
        size_t m_maximal_green_up;
        size_t m_minimal_adjacency;
        size_t m_maximal_adjacency;
        size_t m_minimal_size;
        size_t m_maximal_size;
        size_t m_minimal_neighbors_size;
        size_t m_maximal_neighbors_size;
    };
 
 
 
}
#endif