doxygen/html/FMTSerie_8hpp_source.html

/*

Copyright (c) 2024 Gouvernement du Qu�bec


SPDX-License-Identifier: LiLiQ-R-1.1

License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt

*/


#ifndef FMTSerie_H_INCLUDED

#define FMTSerie_H_INCLUDED


#include <string>


namespace Core

{

// DocString: FMTSerie

class FMTSerie

    {

    public:

        // DocString: FMTSerie(const std::string&,int)

        FMTSerie(const std::string& p_serie, int p_length);

        // DocString: FMTSerie::getLength

        int getLength() const;

        // DocString: FMTSerie::getSerie

        std::string getSerie() 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;

    private:

        // DocString: FMTSerie::m_serie

        std::string m_serie;

        // DocString: FMTSerie::m_length

        int m_length;

    };


}


#endif // FMTSerie_H_INCLUDED

Core::FMTSerie
The class keep information of a serie of actions in a given order.
Definition: FMTSerie.hpp:22

Core::FMTSerie::operator!=
bool operator!=(const FMTSerie &p_RHS) const
Check if two series are not equal.

Core::FMTSerie::getSerie
std::string getSerie() const
Return the string of the serie.

Core::FMTSerie::operator==
bool operator==(const FMTSerie &p_RHS) const
Check if two series are equal.

Core::FMTSerie::operator<
bool operator<(const FMTSerie &p_RHS) const
Check if this serie is less then the p_RHS serie.

Core::FMTSerie::FMTSerie
FMTSerie(const std::string &p_serie, int p_length)
Initialize a FMTSerie using the string description and the length of the serie.

Core::FMTSerie::operator>
bool operator>(const FMTSerie &p_RHS) const
Check if this serie is greater then the p_RHS serie.

Core::FMTSerie::getLength
int getLength() const
Return the length of the serie.

Core
The Core namespace provides classes for simulating stands/strata growth/harvest through time.
Definition: FMTaction.hpp:31