NXObject.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  C++接口JA API的头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     NXObject.ja
//
//  生成工具:
//     apiwrap
//
//  警告:
//    此文件为自动生成，请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/INXObject.hxx>
#include <NXOpen/TaggedObject.hxx>
#include <NXOpen/Update.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 NXObject;
    namespace Assemblies
    {
        class Component;
    }
    class AttributeIterator;
    class BasePart;
    class Expression;
    class INXObject;
    class Unit;
    class _NXObjectBuilder;
    class NXObjectImpl;
    class NXOPENCPPEXPORT  NXObject : public NXOpen::TaggedObject, public virtual NXOpen::INXObject
    {
        public: enum AttributeType
        {
            AttributeTypeInvalid,
            AttributeTypeNull,
            AttributeTypeBoolean,
            AttributeTypeInteger,
            AttributeTypeReal,
            AttributeTypeString,
            AttributeTypeTime,
            AttributeTypeReference,
            AttributeTypeAny = 100
        };

        public: enum DateAndTimeFormat
        {
            DateAndTimeFormatNumeric,
            DateAndTimeFormatTextual
        };

        public:
        struct ComputationalTime
        {
            public:  int Day;
            public:  int Minute;
            public: ComputationalTime() :
                Day(),
                Minute()
            {
            }
            public: ComputationalTime(int dayInitial  ,
                    int minuteInitial  ) :
                Day(dayInitial),
                Minute(minuteInitial)
            {
            }
        };

        public:
        struct AttributeInformation
        {
            public: NXOpen::NXObject::AttributeType Type;
            public: NXString Category;
            public: NXString Title;
            public: NXString TitleAlias;
            public: bool BooleanValue;
            public: int IntegerValue;
            public: double RealValue;
            public: NXString StringValue;
            public: NXString TimeValue;
            public: NXOpen::NXObject::ComputationalTime CompTimeValue;
            public: NXString ReferenceValue;
            public: bool Inherited;
            public: bool IsOverride;
            public: bool Locked;
            public: bool OwnedBySystem;
            public: bool Required;
            public: bool Unset;
            public: bool Array;
            public: bool PdmBased;
            public: bool NotSaved;
            public: int ArrayElementIndex;
            public: NXOpen::Unit * Unit;
            public: NXOpen::Expression * Expression;
            public: bool ExpressionNotLoaded;
public: AttributeInformation() :
                Type((NXOpen::NXObject::AttributeType)0),
                Category(),
                Title(),
                TitleAlias(),
                BooleanValue(),
                IntegerValue(),
                RealValue(),
                StringValue(),
                TimeValue(),
                CompTimeValue(),
                ReferenceValue(),
                Inherited(),
                IsOverride(),
                Locked(),
                OwnedBySystem(),
                Required(),
                Unset(),
                Array(),
                PdmBased(),
                NotSaved(),
                ArrayElementIndex(),
                Unit(),
                Expression(),
                ExpressionNotLoaded()
            {
            }
            public: AttributeInformation(NXOpen::NXObject::AttributeType typeInitial ,
                    const NXString &categoryInitial ,
                    const NXString &titleInitial ,
                    const NXString &titleAliasInitial ,
                    bool booleanValueInitial ,
                    int integerValueInitial ,
                    double realValueInitial ,
                    const NXString &stringValueInitial ,
                    const NXString &timeValueInitial ,
                    const NXOpen::NXObject::ComputationalTime &compTimeValueInitial ,
                    const NXString &referenceValueInitial ,
                    bool inheritedInitial ,
                    bool isOverrideInitial ,
                    bool lockedInitial ,
                    bool ownedBySystemInitial ,
                    bool requiredInitial ,
                    bool unsetInitial ,
                    bool arrayInitial ,
                    bool pdmBasedInitial ,
                    bool notSavedInitial ,
                    int arrayElementIndexInitial ,
                    NXOpen::Unit * unitInitial ,
                    NXOpen::Expression * expressionInitial ,
                    bool expressionNotLoadedInitial ) :
                Type(typeInitial),
                Category(categoryInitial),
                Title(titleInitial),
                TitleAlias(titleAliasInitial),
                BooleanValue(booleanValueInitial),
                IntegerValue(integerValueInitial),
                RealValue(realValueInitial),
                StringValue(stringValueInitial),
                TimeValue(timeValueInitial),
                CompTimeValue(compTimeValueInitial),
                ReferenceValue(referenceValueInitial),
                Inherited(inheritedInitial),
                IsOverride(isOverrideInitial),
                Locked(lockedInitial),
                OwnedBySystem(ownedBySystemInitial),
                Required(requiredInitial),
                Unset(unsetInitial),
                Array(arrayInitial),
                PdmBased(pdmBasedInitial),
                NotSaved(notSavedInitial),
                ArrayElementIndex(arrayElementIndexInitial),
                Unit(unitInitial),
                Expression(expressionInitial),
                ExpressionNotLoaded(expressionNotLoadedInitial)
            {
            }
        };
        private: NXObjectImpl * m_nxobject_impl;
        private: friend class  _NXObjectBuilder;
        protected: NXObject();
        public: ~NXObject();
        public: void SetUserAttribute
        (
            const NXOpen::NXObject::AttributeInformation & info  ,
            NXOpen::Update::Option option 
        );
        public: void SetUserAttribute
        (
            const NXString & title  ,
            int index  ,
            int value  ,
            NXOpen::Update::Option option 
        );
        void SetUserAttribute
        (
            const char * title  ,
            int index  ,
            int value  ,
            NXOpen::Update::Option option 
        );
        public: void SetUserAttribute
        (
            const NXString & title  ,
            int index  ,
            double value  ,
            NXOpen::Update::Option option 
        );
        void SetUserAttribute
        (
            const char * title  ,
            int index  ,
            double value  ,
            NXOpen::Update::Option option 
        );
        public: void SetUserAttribute
        (
            const NXString & title  ,
            int index  ,
            const NXString & value  ,
            NXOpen::Update::Option option 
        );
        void SetUserAttribute
        (
            const char * title  ,
            int index  ,
            const char * value  ,
            NXOpen::Update::Option option 
        );
        public: void SetUserAttribute
        (
            const NXString & title  ,
            int index  ,
            NXOpen::Update::Option option 
        );
        void SetUserAttribute
        (
            const char * title  ,
            int index  ,
            NXOpen::Update::Option option 
        );
        public: void SetTimeUserAttribute
        (
            const NXString & title  ,
            int index  ,
            const NXString & value ,
            NXOpen::Update::Option option 
        );
        void SetTimeUserAttribute
        (
            const char * title  ,
            int index  ,
            const char * value ,
            NXOpen::Update::Option option 
        );
        public: void SetTimeUserAttribute
        (
            const NXString & title  ,
            int index  ,
            const NXOpen::NXObject::ComputationalTime & value ,
            NXOpen::Update::Option option 
        );
        void SetTimeUserAttribute
        (
            const char * title  ,
            int index  ,
            const NXOpen::NXObject::ComputationalTime & value ,
            NXOpen::Update::Option option 
        );
        public: void SetBooleanUserAttribute
        (
            const NXString & title  ,
            int index  ,
            bool value  ,
            NXOpen::Update::Option option 
        );
        void SetBooleanUserAttribute
        (
            const char * title  ,
            int index  ,
            bool value  ,
            NXOpen::Update::Option option 
        );
        public: NXOpen::AttributeIterator * CreateAttributeIterator
        (
        );
        public: bool HasUserAttribute
        (
            NXOpen::AttributeIterator * iterator 
        );
        public: bool HasUserAttribute
        (
            const NXString & title  ,
            NXOpen::NXObject::AttributeType type  ,
            int index 
        );
        bool HasUserAttribute
        (
            const char * title  ,
            NXOpen::NXObject::AttributeType type  ,
            int index 
        );
        public: int GetUserAttributeCount
        (
            NXOpen::AttributeIterator * iterator 
        );
        public: int GetUserAttributeCount
        (
            NXOpen::AttributeIterator * iterator ,
            bool countArrayAsOneAttribute 
        );
        public: int GetUserAttributeCount
        (
            NXOpen::NXObject::AttributeType type 
        );
        public: int GetUserAttributeCount
        (
            NXOpen::NXObject::AttributeType type  ,
            bool includeUnset  ,
            bool countArrayAsOneAttribute 
        );
        public: int GetUserAttributeSize
        (
            const NXString & title  ,
            NXOpen::NXObject::AttributeType type 
        );
        int GetUserAttributeSize
        (
            const char * title  ,
            NXOpen::NXObject::AttributeType type 
        );
        public: bool GetNextUserAttribute
        (
            NXOpen::AttributeIterator * iterator ,
            NXOpen::NXObject::AttributeInformation* info 
        );
        public: NXOpen::NXObject::AttributeInformation GetUserAttribute
        (
            const NXString & title  ,
            NXOpen::NXObject::AttributeType type  ,
            int index 
        );
        NXOpen::NXObject::AttributeInformation GetUserAttribute
        (
            const char * title  ,
            NXOpen::NXObject::AttributeType type  ,
            int index 
        );
        public: bool GetBooleanUserAttribute
        (
            const NXString & title  ,
            int index 
        );
        bool GetBooleanUserAttribute
        (
            const char * title  ,
            int index 
        );
        public: int GetIntegerUserAttribute
        (
            const NXString & title  ,
            int index 
        );
        int GetIntegerUserAttribute
        (
            const char * title  ,
            int index 
        );
        public: double GetRealUserAttribute
        (
            const NXString & title  ,
            int index 
        );
        double GetRealUserAttribute
        (
            const char * title  ,
            int index 
        );
        public: NXString GetStringUserAttribute
        (
            const NXString & title  ,
            int index 
        );
        NXString GetStringUserAttribute
        (
            const char * title  ,
            int index 
        );
        public: NXString GetTimeUserAttribute
        (
            const NXString & title  ,
            int index 
        );
        NXString GetTimeUserAttribute
        (
            const char * title  ,
            int index 
        );
        public: NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute
        (
            const NXString & title  ,
            int index 
        );
        NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute
        (
            const char * title  ,
            int index 
        );
        public: std::vector<NXOpen::NXObject::AttributeInformation> GetUserAttributes
        (
            NXOpen::AttributeIterator * iterator 
        );
        public: std::vector<NXOpen::NXObject::AttributeInformation> GetUserAttributes
        (
        );
        public: std::vector<NXOpen::NXObject::AttributeInformation> GetUserAttributes
        (
            bool includeUnset 
        );
        public: NXString GetUserAttributeAsString
        (
            const NXString & title  ,
            NXOpen::NXObject::AttributeType type  ,
            int index 
        );
        NXString GetUserAttributeAsString
        (
            const char * title  ,
            NXOpen::NXObject::AttributeType type  ,
            int index 
        );
        public: void DeleteUserAttributes
        (
            NXOpen::AttributeIterator * iterator ,
            NXOpen::Update::Option option 
        );
        public: void DeleteUserAttribute
        (
            NXOpen::NXObject::AttributeType type  ,
            const NXString & title  ,
            bool deleteEntireArray  ,
            NXOpen::Update::Option option 
        );
        void DeleteUserAttribute
        (
            NXOpen::NXObject::AttributeType type  ,
            const char * title  ,
            bool deleteEntireArray  ,
            NXOpen::Update::Option option 
        );
        public: void DeleteUserAttributes
        (
            NXOpen::NXObject::AttributeType type  ,
            NXOpen::Update::Option option 
        );
        public: void SetUserAttributeLock
        (
            const NXString & title  ,
            NXOpen::NXObject::AttributeType type  ,
            bool lock 
        );
        void SetUserAttributeLock
        (
            const char * title  ,
            NXOpen::NXObject::AttributeType type  ,
            bool lock 
        );
        public: bool GetUserAttributeLock
        (
            const NXString & title  ,
            NXOpen::NXObject::AttributeType type 
        );
        bool GetUserAttributeLock
        (
            const char * title  ,
            NXOpen::NXObject::AttributeType type 
        );
        public: std::vector<NXOpen::NXObject *> GetUserAttributeSourceObjects
        (
        );
        public: void SetPdmReferenceAttribute
        (
            const NXString & attributeTitle  ,
            const NXString & attributeValue 
        );
        void SetPdmReferenceAttribute
        (
            const char * attributeTitle  ,
            const char * attributeValue 
        );
        public: NXString GetPdmReferenceAttributeValue
        (
            const NXString & attributeTitle 
        );
        NXString GetPdmReferenceAttributeValue
        (
            const char * attributeTitle 
        );
        public: NX_DEPRECATED("Deprecated in NX11.0.0.  Use GetUserAttribute instead.") std::vector<NXOpen::NXObject::AttributeInformation> GetUserAttribute
        (
            const NXString & title  ,
            bool includeUnset  ,
            bool addStringValues  ,
            NXOpen::NXObject::AttributeType type 
        );
        std::vector<NXOpen::NXObject::AttributeInformation> GetUserAttribute
        (
            const char * title  ,
            bool includeUnset  ,
            bool addStringValues  ,
            NXOpen::NXObject::AttributeType type 
        );
        public: NX_DEPRECATED("Deprecated in NX11.0.0.  Use GetUserAttributes instead.") std::vector<NXOpen::NXObject::AttributeInformation> GetUserAttributes
        (
            bool includeUnset  ,
            bool addStringValues 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use DeleteUserAttributes instead.") void DeleteAllAttributesByType
        (
            NXOpen::NXObject::AttributeType type 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use DeleteUserAttributes instead.") void DeleteAllAttributesByType
        (
            NXOpen::NXObject::AttributeType type  ,
            NXOpen::Update::Option option 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetAttribute
        (
            const NXString & title  ,
            int value 
        );
        void SetAttribute
        (
            const char * title  ,
            int value 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetAttribute
        (
            const NXString & title  ,
            int value  ,
            NXOpen::Update::Option option 
        );
        void SetAttribute
        (
            const char * title  ,
            int value  ,
            NXOpen::Update::Option option 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetAttribute
        (
            const NXString & title  ,
            double value 
        );
        void SetAttribute
        (
            const char * title  ,
            double value 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetAttribute
        (
            const NXString & title  ,
            double value  ,
            NXOpen::Update::Option option 
        );
        void SetAttribute
        (
            const char * title  ,
            double value  ,
            NXOpen::Update::Option option 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetAttribute
        (
            const NXString & title  ,
            const NXString & value 
        );
        void SetAttribute
        (
            const char * title  ,
            const char * value 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetAttribute
        (
            const NXString & title  ,
            const NXString & value  ,
            NXOpen::Update::Option option 
        );
        void SetAttribute
        (
            const char * title  ,
            const char * value  ,
            NXOpen::Update::Option option 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetAttribute
        (
            const NXString & title 
        );
        void SetAttribute
        (
            const char * title 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetAttribute
        (
            const NXString & title  ,
            NXOpen::Update::Option option 
        );
        void SetAttribute
        (
            const char * title  ,
            NXOpen::Update::Option option 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetTimeAttribute
        (
            const NXString & title  ,
            const NXString & value 
        );
        void SetTimeAttribute
        (
            const char * title  ,
            const char * value 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetTimeAttribute
        (
            const NXString & title  ,
            const NXString & value ,
            NXOpen::Update::Option option 
        );
        void SetTimeAttribute
        (
            const char * title  ,
            const char * value ,
            NXOpen::Update::Option option 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use GetUserAttribute instead.") int GetIntegerAttribute
        (
            const NXString & title 
        );
        int GetIntegerAttribute
        (
            const char * title 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use GetUserAttribute instead.") double GetRealAttribute
        (
            const NXString & title 
        );
        double GetRealAttribute
        (
            const char * title 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use GetUserAttribute instead.") NXString GetStringAttribute
        (
            const NXString & title 
        );
        NXString GetStringAttribute
        (
            const char * title 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use GetUserAttribute instead.") NXString GetTimeAttribute
        (
            NXOpen::NXObject::DateAndTimeFormat format  ,
            const NXString & title 
        );
        NXString GetTimeAttribute
        (
            NXOpen::NXObject::DateAndTimeFormat format  ,
            const char * title 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use GetUserAttribute instead.") NXString GetReferenceAttribute
        (
            const NXString & title 
        );
        NXString GetReferenceAttribute
        (
            const char * title 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use DeleteUserAttribute instead.") void DeleteAttributeByTypeAndTitle
        (
            NXOpen::NXObject::AttributeType type  ,
            const NXString & title 
        );
        void DeleteAttributeByTypeAndTitle
        (
            NXOpen::NXObject::AttributeType type  ,
            const char * title 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use DeleteUserAttribute instead.") void DeleteAttributeByTypeAndTitle
        (
            NXOpen::NXObject::AttributeType type  ,
            const NXString & title  ,
            NXOpen::Update::Option option 
        );
        void DeleteAttributeByTypeAndTitle
        (
            NXOpen::NXObject::AttributeType type  ,
            const char * title  ,
            NXOpen::Update::Option option 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetReferenceAttribute
        (
            const NXString & title  ,
            const NXString & value 
        );
        void SetReferenceAttribute
        (
            const char * title  ,
            const char * value 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use SetUserAttribute instead.") void SetReferenceAttribute
        (
            const NXString & title  ,
            const NXString & value  ,
            NXOpen::Update::Option option 
        );
        void SetReferenceAttribute
        (
            const char * title  ,
            const char * value  ,
            NXOpen::Update::Option option 
        );
        public: NX_DEPRECATED("Deprecated in NX8.0.0.  Use GetUserAttributes instead.") std::vector<NXOpen::NXObject::AttributeInformation> GetAttributeTitlesByType
        (
            NXOpen::NXObject::AttributeType type 
        );
        public: NX_DEPRECATED("Deprecated in NX8.5.0.  Use GetUserAttributes instead.") std::vector<NXString> GetUserAttributesAsStrings
        (
        );
        public: virtual NXOpen::INXObject * FindObject
        (
            const NXString & journalIdentifier 
        );
        virtual NXOpen::INXObject * FindObject
        (
            const char * journalIdentifier 
        );
        public: virtual NXString JournalIdentifier
        (
        );
        public: virtual bool IsOccurrence
        (
        );
        public: virtual NXOpen::INXObject * Prototype
        (
        );
        public: virtual NXOpen::Assemblies::Component * OwningComponent
        (
        );
        public: virtual NXOpen::BasePart * OwningPart
        (
        );
        public: virtual void Print
        (
        );
        public: virtual NXString Name
        (
        );
        public: virtual void SetName
        (
            const NXString & name 
        );
        virtual void SetName
        (
            const char * name 
        );
    };
}
#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