Validation.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  C++接口JA API的头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     Validation.ja
//
//  生成工具:
//     apiwrap
//
//  警告:
//    此文件为自动生成 - 请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/NXObject.hxx>
#include <NXOpen/libnxopencpp_exports.hxx>
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4996)
#endif
#ifdef __GNUC__
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
namespace NXOpen
{
    class Validation;
    class NXObject;
    class _ValidationBuilder;
    class ValidationImpl;
    class NXOPENCPPEXPORT  Validation : public NXOpen::NXObject
    {
        public: enum Result
        {
            ResultPass,
            ResultInformation,
            ResultWarning,
            ResultFailed,
            ResultUnknown,
            ResultSkipped
        };

        public: enum InputType
        {
            InputTypeKfClass,
            InputTypeSpreadsheet,
            InputTypeTextFile,
            InputTypeXml,
            InputTypeTcr,
            InputTypeApplication,
            InputTypeNum,
            InputTypePmi,
            InputTypeVdv
        };

        public: enum UpdateTime
        {
            UpdateTimeEveryChange,
            UpdateTimeSave
        };

        public: enum MapType
        {
            MapTypeText,
            MapTypeReal,
            MapTypeInt,
            MapTypeTime,
            MapTypeTag,
            MapTypeNone
        };
        private: ValidationImpl * m_validation_impl;
        private: friend class  _ValidationBuilder;
        protected: Validation();
        public: ~Validation();
        public: void SetUpdateControl
        (
            NXOpen::Validation::UpdateTime updateTime 
        );
        public: void Add
        (
            const NXString & key ,
            const std::vector<NXOpen::NXObject *> & objs 
        );
        void Add
        (
            const char * key ,
            const std::vector<NXOpen::NXObject *> & objs 
        );
        public: void Replace
        (
            const NXString & key ,
            const std::vector<NXOpen::NXObject *> & objs 
        );
        void Replace
        (
            const char * key ,
            const std::vector<NXOpen::NXObject *> & objs 
        );
        public: void Add
        (
            const NXString & key ,
            const NXString & text 
        );
        void Add
        (
            const char * key ,
            const char * text 
        );
        public: void Add
        (
            const NXString & key ,
            double number 
        );
        void Add
        (
            const char * key ,
            double number 
        );
        public: void Add
        (
            const NXString & key ,
            int number 
        );
        void Add
        (
            const char * key ,
            int number 
        );
        public: void Add
        (
            const NXString & key ,
            int day ,
            int time 
        );
        void Add
        (
            const char * key ,
            int day ,
            int time 
        );
        public: NXOpen::Validation::Result Evaluate
        (
        );
        public: NXOpen::Validation::Result GetCheckResult
        (
        );
        public: void SetCheckResult
        (
            NXOpen::Validation::Result result 
        );
        public: std::vector<NXString> GetKeys
        (
        );
        public: NXOpen::Validation::MapType GetKeyType
        (
            const NXString & key 
        );
        NXOpen::Validation::MapType GetKeyType
        (
            const char * key 
        );
        public: void SetUserClassName
        (
            const NXString & name 
        );
        void SetUserClassName
        (
            const char * name 
        );
        public: std::vector<NXOpen::NXObject *> Lookup
        (
            const NXString & key 
        );
        std::vector<NXOpen::NXObject *> Lookup
        (
            const char * key 
        );
        public: void LookupNumber
        (
            const NXString & key ,
            double* number ,
            bool* found 
        );
        void LookupNumber
        (
            const char * key ,
            double* number ,
            bool* found 
        );
        public: void LookupText
        (
            const NXString & key ,
            NXString* text ,
            bool* found 
        );
        void LookupText
        (
            const char * key ,
            NXString* text ,
            bool* found 
        );
        public: void LookupInteger
        (
            const NXString & key ,
            int* number ,
            bool* found 
        );
        void LookupInteger
        (
            const char * key ,
            int* number ,
            bool* found 
        );
        public: void LookupTime
        (
            const NXString & key ,
            int* day ,
            int* time ,
            bool* found 
        );
        void LookupTime
        (
            const char * key ,
            int* day ,
            int* time ,
            bool* found 
        );
        public: void Remove
        (
            const NXString & key 
        );
        void Remove
        (
            const char * key 
        );
        public: bool GetSuppressed
        (
        );
        public: void SetSuppressed
        (
            bool suppress 
        );
        public: NXOpen::Validation::Result GetInitialResult
        (
        );
        public: void Delete
        (
        );
        public: void Information
        (
        );
        public: NXString Requirement
        (
        );
        public: void SetRequirement
        (
            const NXString & requirement 
        );
        void SetRequirement
        (
            const char * requirement 
        );
        public: void GetAssociatedObjects
        (
            std::vector<NXOpen::NXObject *> & objects 
        );
        public: void SetAssociatedObjects
        (
            const std::vector<NXOpen::NXObject *> & objects 
        );
    };
}
#ifdef _MSC_VER
#pragma warning(pop)
#endif
#ifdef __GNUC__
#ifndef NX_NO_GCC_DEPRECATION_WARNINGS
#pragma GCC diagnostic warning "-Wdeprecated-declarations"
#endif
#endif
#undef EXPORTLIBRARY