MfgValidationTestInterface.hxx

Go to the documentation of this file.

/* Copyright 2022 Siemens Digital Industries Software
 ==================================================
 Copyright 2020.
 Siemens Product Lifecycle Management Software Inc.
 All Rights Reserved.
 ==================================================
 Copyright 2022 Siemens Digital Industries Software */

#ifndef ME_TEAMCENTER_MFGVALIDATIONTESTINTERFACE_HXX  
#define ME_TEAMCENTER_MFGVALIDATIONTESTINTERFACE_HXX 

#include <vector>
#include <string>
#include <map>
#include <unidefs.h>
#include <me/libme_exports.h>

const int ValidationTestResult_Pass = 0;
const int ValidationTestResult_Fail = 1;
const int ValidationTestResult_Warning = 2;
const int ValidationTestResult_Caution = 3;
const int ValidationTestResult_NotApplicable = 4;  /* If the validation suite does not return a Pass,Fail,Warning or Caution for a validation test it is assumed to be Not Applicable */

const int ValidationTestResultMessageType_Info = 0;
const int ValidationTestResultMessageType_Error = 1;
const int ValidationTestResultMessageType_Warning = 2;
const int ValidationTestResultMessageType_Caution = 3;

struct ValidationTestResult
{
    std::string validationTestSuiteName;    
    std::string validationTestName;         
    int validationTestResult;               
    int messageType;                        
    std::string statusMessage;              
};

typedef std::map<tag_t, std::vector<tag_t> > InputObjectToFoundObjectsMap;

typedef std::map<tag_t, std::vector<ValidationTestResult> > TestedObjectToValidationResultsMap;

typedef int (*validation_testsuite_callback_fn_t)
    (const InputObjectToFoundObjectsMap & inputObjectToFoundObjectsMap,  
     const std::vector<std::string> & validationTestNames,               
     std::vector<std::string> & additionalInfo,                          
     TestedObjectToValidationResultsMap & validationTestResults          
    );

#include <me/libme_undef.h>
#endif