mna_verification.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef MNA_VERIFICATION_H
#define MNA_VERIFICATION_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "mna_global.h"
#include "mna_script.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QString>
#include <QStringList>
#include <QVariant>
#include <QVariantMap>
#include <QMap>
#include <QList>
#include <QDateTime>
#include <QJsonObject>
#include <QCborMap>
 
//=============================================================================================================
// DEFINE NAMESPACE MNALIB
//=============================================================================================================
 
namespace MNALIB
{
 
//=============================================================================================================
struct MNASHARED_EXPORT MnaVerificationCheck
{
    QString     id;             
    QString     description;    
    QString     phase;          
    QString     expression;     
    MnaScript   script;         
    QString     severity;       
    QString     onFail;         
 
    QJsonObject toJson() const;
    static MnaVerificationCheck fromJson(const QJsonObject& json);
    QCborMap toCbor() const;
    static MnaVerificationCheck fromCbor(const QCborMap& cbor);
};
 
//=============================================================================================================
struct MNASHARED_EXPORT MnaVerificationResult
{
    QString     checkId;        
    bool        passed = false; 
    QString     severity;       
    QString     message;        
    QVariant    actualValue;    
    QDateTime   evaluatedAt;    
 
    QJsonObject toJson() const;
    static MnaVerificationResult fromJson(const QJsonObject& json);
    QCborMap toCbor() const;
    static MnaVerificationResult fromCbor(const QCborMap& cbor);
};
 
//=============================================================================================================
struct MNASHARED_EXPORT MnaProvenance
{
    // Input snapshot
    QMap<QString, QString> inputHashes;     
 
    // Resolved attributes at execution time (after param-tree evaluation)
    QVariantMap resolvedAttributes;
 
    // Software environment
    QString     mneCppVersion;              
    QString     qtVersion;                  
    QString     compilerInfo;               
    QString     osInfo;                     
    QString     hostName;                   
 
    // For IPC/Script nodes
    QString     externalToolVersion;        
 
    // Timing
    QDateTime   startedAt;
    QDateTime   finishedAt;
    qint64      wallTimeMs = 0;             
    qint64      peakMemoryBytes = 0;        
 
    // Random seed (if stochastic operations were used)
    qint64      randomSeed = -1;            
 
    QJsonObject toJson() const;
    static MnaProvenance fromJson(const QJsonObject& json);
    QCborMap toCbor() const;
    static MnaProvenance fromCbor(const QCborMap& cbor);
};
 
//=============================================================================================================
struct MNASHARED_EXPORT MnaVerification
{
    QString     explanation;

    QList<MnaVerificationCheck> checks;

    QList<MnaVerificationResult> preResults;

    QList<MnaVerificationResult> postResults;

    MnaProvenance provenance;
 
    QJsonObject toJson() const;
    static MnaVerification fromJson(const QJsonObject& json);
    QCborMap toCbor() const;
    static MnaVerification fromCbor(const QCborMap& cbor);
};
 
} // namespace MNALIB
 
#endif // MNA_VERIFICATION_H