FMTOperator.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 FMTOPE_Hm_included
#define FMTOPE_Hm_included
 
#include "FMTutility.h"
#include <string>
#include <vector>
#include <boost/functional/hash.hpp>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include "FMTException.h"
 
 
 
namespace Core
{
 
    // DocString: FMTokey
    enum class FMTokey
    {
        multiply = 1,
        divide = 2,
        add = 3,
        sub = 4,
        comma = 5,
        pow = 6,
        notvalid = 7
    };
 
// DocString: FMTOperator
class FMTEXPORT FMTOperator
{
public:
    // DocString: FMTOperator()
    FMTOperator();
    // DocString: ~FMTOperator()
    ~FMTOperator() = default;
    // DocString: FMTOperator(FMTokey)
    FMTOperator(FMTokey lkey);
    // DocString: FMTOperator(std::string)
    FMTOperator(std::string strkey);
    // DocString: FMTOperator::operator==
    bool operator == (const FMTOperator& rhs) const;
    // DocString: FMTOperator::operator!=
    bool operator != (const FMTOperator& rhs) const;
    // DocString: FMTOperator::call
    double call(const double& rhs1, const double& rhs2) const;
    // DocString: FMTOperator(const FMTOperator&)
    FMTOperator(const FMTOperator& rhs);
    // DocString: FMTOperator::operator=
    FMTOperator& operator = (const FMTOperator& rhs);
    // DocString: FMTOperator::precedence
    int precedence() const;
    // DocString: FMTOperator::associativity
    std::string associativity() const;
    // DocString: FMTOperator::reverse
    FMTOperator reverse() const;
    // DocString: FMTOperator::valid
    bool valid() const;
    // DocString: FMTOperator::hash
    size_t hash() const;
    // DocString: FMTOperator::isFactor
    bool isFactor() const;
    // DocString: FMTOperator::isDivide
    bool isDivide() const;
    // DocString: FMTOperator::getKey
    FMTokey getKey() const;
    // DocString: FMTOperator::operator std::string
    operator std::string() const;
private:
    FMTokey m_key;
    friend class boost::serialization::access;
    // DocString: FMTOperator::serialize
    template<class Archive>
    void serialize(Archive& ar, const unsigned int version)
    {
        ar & boost::serialization::make_nvp("key", m_key);
    }
};
 
}
 
#endif // FMTOPE_Hm_included