FMTMaskFilter.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 FMTMASKFILTER_Hm_included
#define FMTMASKFILTER_Hm_included
 
 
#include <boost/dynamic_bitset.hpp>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <vector>
#include  <boost/functional/hash.hpp>
#include "FMTutility.h"
 
 
namespace Core
{
    class FMTMask;
    class FMTTheme;
 
 
// DocString: FMTMaskFilter
class FMTEXPORT FMTMaskFilter
    {
    public:
        // DocString: FMTMaskFilter()
        FMTMaskFilter();
        // DocString: ~FMTMaskFilter()
        virtual ~FMTMaskFilter()=default;
        // DocString: FMTMaskFilter(const FMTMaskFilter&)
        FMTMaskFilter(const FMTMaskFilter& rhs);
        // DocString: FMTMaskFilter::operator=
        FMTMaskFilter& operator = (const FMTMaskFilter& rhs);
        // DocString: FMTMaskFilter(const FMTMask&, const FMTMask&)
        FMTMaskFilter(const FMTMask& presolveselection, const FMTMask& buffermask);
        // DocString: FMTMaskFilter(const FMTMask&)
        FMTMaskFilter(const FMTMask& presolveselection);
        // DocString: FMTMaskFilter(std::vector<FMTMask>&)
        FMTMaskFilter(std::vector<FMTMask>& masks);
        // DocString: FMTMaskFilter(std::vector<FMTMask>&,const std::vector<FMTTheme>&)
        FMTMaskFilter(std::vector<FMTMask>& masks,const std::vector<FMTTheme>& themes);
        // DocString: FMTMaskFilter::filter
        FMTMask filter(const FMTMask& devmask) const;
        // DocString: FMTMaskFilter::swap
        void swap(FMTMaskFilter& rhs);
        // DocString: FMTMaskFilter::preSolve
        FMTMaskFilter preSolve(const std::vector<FMTTheme>& themes) const;
        // DocString: FMTMaskFilter::canPreSolve
        bool canPreSolve(const FMTMask& mask, const std::vector<const Core::FMTTheme*>& themes) const;
        // DocString: FMTMaskFilter::getSelectedThemes
        std::vector<const Core::FMTTheme*> getSelectedThemes(const std::vector<Core::FMTTheme>& themes) const;
        // DocString: FMTMaskFilter::emptyFlipped
        inline bool emptyFlipped() const
            {
            return flippedselection.empty();
            }
        // DocString: FMTMaskFilter::empty
        inline bool empty() const
            {
            return selection.empty();
            }
        // DocString: FMTMaskFilter::hash
        inline size_t hash() const
            {
            return (boost::hash<boost::dynamic_bitset<uint8_t>>()(selection) ^ boost::hash<boost::dynamic_bitset<uint8_t>>()(flippedselection));
            }
    protected:
        /*boost::dynamic_bitset<> fullset;*/
        boost::dynamic_bitset<uint8_t> selection;
        boost::dynamic_bitset<uint8_t> flippedselection;
        //std::vector<size_t>index;
    private:
    friend class boost::serialization::access;
    friend class FMTTheme;
    friend class FMTMask;
    // DocString: FMTMaskFilter::serialize
    template<class Archive>
    void serialize(Archive& ar, const unsigned int version)
        {
        /*ar & BOOST_SERIALIZATION_NVP(fullset);*/
        ar & BOOST_SERIALIZATION_NVP(selection);
        ar & BOOST_SERIALIZATION_NVP(flippedselection);
        //ar & BOOST_SERIALIZATION_NVP(index);
        }
    };
 
 
 
}
 
namespace boost {
 
    template <>
    struct hash<Core::FMTMaskFilter>
    {
        std::size_t operator()(const Core::FMTMaskFilter& filter) const
        {
 
            return (filter.hash());
        }
    };
 
 
}
 
#endif // FMTMASKFILTER_Hm_included