EvaluationDebugData.h

// Copyright QED Software 2023.
 
#ifndef GRAIL_EVALUATION_DEBUG_DATA_H
#define GRAIL_EVALUATION_DEBUG_DATA_H
 
#include <string>
#include <vector>
#include "../UtilityModel/EvaluatorType.h"
#include "Flatbuffers/EvaluationDebugData_generated.h"
 
namespace YAML
{
    template <typename DataType>
    struct convert;
}
 
namespace grail
{
namespace data
{
    class EvaluationDebugData
    {
        friend struct YAML::convert<EvaluationDebugData>;
    public:
        EvaluationDebugData(EvaluatorType evaluatorType, float score, unsigned int nodeIndex);
        EvaluationDebugData() = default;
 
        void AddChildNode(unsigned int childNodeIndex);
 
        EvaluatorType GetEvaluatorType() const;
 
        float GetScore() const;
 
        unsigned int GetNodeIndex() const;
 
        const std::vector<unsigned int>& GetChildNodes() const;
 
        const std::string& GetMetadata() const;
 
        void SetMetadata(const std::string& newMetadata);
 
    private:
        EvaluatorType evaluatorType{};
        float score{};
        unsigned int nodeIndex{};
        std::vector<unsigned int> childNodes{};
        std::string metadata{};
    };
 
    flatbuffers::Offset<generated::EvaluationDebugData> Pack(flatbuffers::FlatBufferBuilder& builder, const EvaluationDebugData& debugData);
    EvaluationDebugData Unpack(const generated::EvaluationDebugData& debugData);
}
}
 
#endif