FMTOutputNode.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 FMTOUTPUTNODE_Hm_included
#define FMTOUTPUTNODE_Hm_included
 
#include "FMTOutputSource.h"
#include <map>
 
#include "FMTutility.h"
 
namespace Core
{
class FMTAction;
 
// DocString: FMTOutputNode
class FMTEXPORT FMTOutputNode
    {
    public:
        FMTOutputSource source;
        FMTOutputSource factor;
        double constant;
        // DocString: FMTOutputNode()
        FMTOutputNode();
        // DocString: FMTOutputNode(const FMTOutputSource&, const FMTOutputSource&, const double&)
        FMTOutputNode(const FMTOutputSource& lsource, const FMTOutputSource& lfactor, const double& lconstant);
        // DocString: FMTOutputNode(const FMTOutputNode&)
        FMTOutputNode(const FMTOutputNode& rhs);
        // DocString: FMTLpHeuristic::FMTOutputNode
        FMTOutputNode(const Core::FMTMask& generalmask,const std::string& actionaggregate);
        // DocString: FMTOutputNode::hash
        size_t hash() const;
        // DocString: FMTOutputNode::hashForValue
        size_t hashForValue() const;
        // DocString: FMTOutputNode::allowCashDeduction
        bool allowCashDeduction() const;
        // DocString: FMTOutputNode::singlePeriod
        bool singlePeriod() const;
        // DocString: FMTOutputNode::multiPeriod
        bool multiPeriod() const;
        // DocString: FMTOutputNode::isPastPeriod
        bool isPastPeriod() const;
        // DocString: FMTOutputNode::isNull
        bool isNull() const;
        // DocString: FMTOutputNode::operator<
        bool operator < (const FMTOutputNode& rhs) const;
        // DocString: FMTOutputNode::operator==
        bool operator == (const FMTOutputNode& rhs) const;
        // DocString: FMTOutputNode::isSubsetOf(const FMTOutputNode&)
        bool isSubsetOf(const FMTOutputNode& rhs) const;
        // DocString: FMTOutputNode::isSubsetOf(const FMTOutputNode&,const std::vector<Core::FMTAction>&)
        bool isSubsetOf(const FMTOutputNode& rhs,const std::vector<Core::FMTAction>& actions) const;
        // DocString: FMTOutputNode::isSameButDifferentAction
        bool isSameButDifferentAction(const FMTOutputNode& rhs) const;
        // DocString: FMTOutputNode::getOutputId
        inline int getOutputId() const
            {
            return source.getOutputOrigin();
            }
        // DocString: FMTOutputNode::isActionBased
        inline bool isActionBased() const
            {
            return source.isAction();
            }
        // DocString: FMTOutputNode::isSameValues
        bool isSameValues(const FMTOutputNode& rhs) const;
        // DocString: FMTOutputNode::operator std::string
        operator std::string() const;
        // DocString: FMTOutputNode::getHashString
        std::string getHashString() const;
        // DocString: FMTOutputNode::getHashMask
        Core::FMTMask getHashMask() const;
        // DocString: FMTOutputNode::fillHashMaskSpec
        void fillHashMaskSpec(Core::FMTMask& baseMask) const;
        // DocString: FMTOutputNode::setPeriod
        FMTOutputNode setPeriod(int period) const;
        // DocString: FMTOutputNode::operator=
        FMTOutputNode& operator = (const FMTOutputNode& rhs);
        // DocString: FMTOutputNode::setToGraph
        int setToGraph(std::vector<int>& targetedperiods, int period,int max_period);
        // DocString: ~FMTOutputNode()
        ~FMTOutputNode()=default;
        // DocString: FMTOutputNode::fillUpEquation
        void fillUpEquation(std::map<std::string,std::vector<std::string>>& allequations,
            const std::map<std::string, double>& graphvalues,
            const std::vector<std::string>& equation, const size_t& nodeid) const;
    };
 
// DocString: FMTOutputNodeValueComparator
class FMTOutputNodeValueComparator
    {
    public:
        // DocString: FMTOutputNodeValueComparator::operator()
        bool operator()(const FMTOutputNode& node1, const FMTOutputNode& node2) const;
 
    };
 
// DocString: FMTOutputNodeOriginComparator
class FMTOutputNodeOriginComparator
{
public:
    // DocString: FMTOutputNodeOriginComparator::operator()
    bool operator()(const FMTOutputNode& node1, const FMTOutputNode& node2) const;
 
};
 
// DocString: FMTOutputNodeHasher
class FMTOutputNodeHasher 
    {
    public:
        // DocString: FMTOutputNodeHasher::operator()
        size_t operator()(const FMTOutputNode & node) const;
    };
 
 
}
 
BOOST_CLASS_EXPORT_KEY(Core::FMTOutputNode)
 
#endif