FMTSerie.h

Go to the documentation of this file.

/*
Copyright (c) 2024 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
 
#ifndef FMTSerie_Hm_included
#define FMTSerie_Hm_included
 
#include <string>
#include <vector>
#include "FMTutility.h"
 
 
namespace Core
{
// DocString: FMTSerie
class FMTEXPORT FMTSerie
    {
    public:
        // DocString: FMTSerie()
        FMTSerie();
        // DocString: FMTSerie(const std::string&, int)
        FMTSerie(const std::string& p_serie, int p_length);
        // DocString: FMTSerie(const std::vector<std::string>&, int)
        FMTSerie(const std::vector<std::string>& p_serie, int p_length);
        // DocString: FMTSerie(const std::vector<std::string>&, bool, bool)
        FMTSerie(const std::vector<std::string>& p_serie, 
                            bool p_asap, bool p_alap);
        // DocString: FMTSerie::getLength
        int getLength() const;
        // DocString: FMTSerie::getActions
        const std::vector<std::string>& getActions() const;
        // DocString: FMTSerie::getSerie
        const std::string getSerie() const;
        // DocString: FMTSerie::operator std::string
        operator std::string() const;
        // DocString: FMTSerie::operator==
        bool operator == (const FMTSerie& p_RHS) const;
        // DocString: FMTSerie::operator!=
        bool operator != (const FMTSerie& p_RHS) const;
        // DocString: FMTSerie::operator<
        bool operator < (const FMTSerie & p_RHS) const;
        // DocString: FMTSerie::operator>
        bool operator > (const FMTSerie& p_RHS) const;
        // DocString: FMTSerie::isASAP
        bool isASAP() const;
        // DocString: FMTSerie::isALAP
        bool isALAP() const;
        // DocString: FMTSerie::getLength
        bool isAllowedInSerie(const std::vector<std::string>& p_SerieMask) const;
        // DocString: FMTSerie::isEmpty
        bool isEmpty() const;
    private:
        // DocString: FMTSerie::m_serie
        std::vector<std::string> m_serie;
        // DocString: FMTSerie::m_length
        int m_length;
        // DocString: FMTSerie::m_SEPERATOR
        static const std::string m_SEPERATOR;
 
    };
 
}
 
#endif // FMTSerie_Hm_included