BasePart.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
// C++接口到JA API的头文件
//--------------------------------------------------------------------------
//
// 源文件:
//     BasePart.ja
//
// 生成工具:
//     apiwrap
//
// 警告:
//    此文件自动生成 - 请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/Display_DynamicSectionBuilder.hxx>
#include <NXOpen/EffectivityConditionBuilder.hxx>
#include <NXOpen/NXObject.hxx>
#include <NXOpen/PartCloseResponses.hxx>
#include <NXOpen/PartLoadStatus.hxx>
#include <NXOpen/PartReopenReport.hxx>
#include <NXOpen/PartSaveStatus.hxx>
#include <NXOpen/PartTypes.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 BasePart;
    namespace Annotations
    {
        class AnnotationManager;
    }
    class ArcCollection;
    namespace Assemblies
    {
        class Arrangement;
    }
    namespace Assemblies
    {
        class AssemblyManager;
    }
    namespace Assemblies
    {
        class ComponentAssembly;
    }
    namespace Assemblies
    {
        class PartitionSchemeManager;
    }
    namespace Assemblies
    {
        class ProductOutlineManager;
    }
    class AxisCollection;
    namespace CAE
    {
        class CurveOperationExpressionRecordCollection;
    }
    namespace CAE
    {
        class FunctionCollection;
    }
    namespace CAE
    {
        class LayoutStateCollection;
    }
    namespace CAE
    {
        class LayoutStatePreferences;
    }
    namespace CAE
    {
        class PostScenarioManager;
    }
    namespace CAE
    {
        class ViewLayoutManager;
    }
    namespace CAM
    {
        class CAMFeatureCollection;
    }
    class CollaborativeDesign;
    class ColorManager;
    class ConfiguredPart;
    class CoordinateSystemCollection;
    class CurveCollection;
    class DatumCollection;
    namespace DesignSimulation
    {
        class PostManager;
    }
class DirectionCollection;
namespace Display
{
    class AnimationCameraCollection;
}
namespace Display
{
    class CameraCollection;
}
namespace Display
{
    class CgfxAttrCollection;
}
namespace Display
{
    class CgfxMattexCollection;
}
namespace Display
{
    class DecalCollection;
}
namespace Display
{
    class DynamicSectionBuilder;
}
namespace Display
{
    class DynamicSectionCollection;
}
namespace Display
{
    class FacetSettingsBuilder;
}
namespace Display
{
    class GridCollection;
}
namespace Display
{
    class ImageCollection;
}
namespace Display
{
    class ImageDataCollection;
}
namespace Display
{
    class PerspectiveOptionsBuilder;
}
namespace Display
{
    class PointCloudCollection;
}
namespace Display
{
    class SelPrefCollection;
}
namespace Display
{
    class TrueShadingCollection;
}
namespace Display
{
    class TrueStudioCollection;
}
namespace Display
{
    class UVMapCollection;
}
namespace Display
{
    class VisualMaterialCollection;
}
namespace Drawings
{
    class ConvertToPMIBuilderManager;
}
class EffectivityConditionBuilder;
class EllipseCollection;
class ExpressionCollection;
class ExpressionGroupCollection;
class ExternalFileReferenceManager;
namespace Features
{
    class BaseFeatureCollection;
}
namespace Features
{
    class FeatureCollection;
}
namespace Features
{
    class SelectionProgramCollection;
}
namespace Fields
{
    class FieldManager;
}
class FontCollection;
namespace Gateway
{
    class ImageCaptureManager;
}
namespace GeometricAnalysis
    {
        class AnalysisManager;
    }
    namespace GeometricAnalysis
    {
        class AnalysisResultCollection;
    }
    class Group;
    class GroupBuilder;
    class HyperbolaCollection;
    namespace Implicit
    {
        class ImplicitOperationCollection;
    }
    class InfiniteLineCollection;
    namespace Layer
    {
        class CategoryCollection;
    }
    namespace Layer
    {
        class LayerManager;
    }
    class LayoutCollection;
    class LightCollection;
    class LineCollection;
    namespace Markup
    {
        class MarkupCollection;
    }
    class MaterialManager;
    class MeasureManager;
    namespace MendixReporting
    {
        class CadInfoManager;
    }
    namespace MendixReporting
    {
        class CheckerData;
    }
    class ModelingViewCollection;
    class NXMatrixCollection;
    class NXObject;
    class OffsetCollection;
    namespace Optimization
    {
        class DesignStudyCollection;
    }
    namespace Optimization
    {
        class OptimizationCollection;
    }
    namespace PDM
    {
        class PdmPart;
    }
    class ParabolaCollection;
    class ParamLibParameterLibraryManager;
    class ParameterTableCollection;
    class PartCloseResponses;
    class PartLoadStatus;
    class PartReopenReport;
    class PartSaveOptions;
    class PartSaveStatus;
    class PlaneCollection;
    class PlotManager;
    class PointCollection;
    class PolylineCollection;
    namespace Preferences
    {
        class PartPreferences;
    }
    class PropertiesManager;
    class ReferenceSet;
    class RuleManager;
    class ScCollectorCollection;
    class ScRuleFactory;
    class ScalarCollection;
    class SectionCollection;
    class SplineCollection;
    class StrokeCollection;
    class UnitCollection;
    namespace UserDefinedObjects
    {
        class UserDefinedObjectManager;
    }
    namespace UserDefinedTemplate
    {
        class ConfigurationManager;
    }
    namespace Validate
    {
        class AnalysisResultCollection;
    }
    namespace Validate
    {
        class PersistentResultCollection;
    }
    namespace Validate
    {
        class RequirementCheckCollection;
    }
namespace Validate
    {
        class RequirementCollection;
    }
    class ValidationCollection;
    class ViewCollection;
    class ViewSetCollection;
    class WCS;
    class XformCollection;
    class _BasePartBuilder;
    class BasePartImpl;
    class NXOPENCPPEXPORT  BasePart : public NXOpen::NXObject
    {
        public: enum BookmarkOption
        {
            BookmarkOptionAll,
            BookmarkOptionComponentGroupsLoadOptions,
            BookmarkOptionComponentGroupsOnly,
            BookmarkOptionAllPlusDisplay,
            BookmarkOptionComponentGroupsLoadOptionsPlusDisplay,
            BookmarkOptionComponentGroupsOnlyPlusDisplay,
            BookmarkOptionDisplayOnly,
            BookmarkOptionEmpty
        };

        public: enum Units
        {
            UnitsInches ,
            UnitsMillimeters ,
            UnitsMix ,
            UnitsMeters ,
            UnitsMicrometers
        };

        public: enum SaveComponents
        {
            SaveComponentsFalse ,
            SaveComponentsTrue
        };

        public: enum CloseAfterSave
        {
            CloseAfterSaveFalse ,
            CloseAfterSaveTrue
        };

        public: enum CloseWholeTree
        {
            CloseWholeTreeFalse ,
            CloseWholeTreeTrue
        };

        public:
        struct HistoryEventInformation
        {
            public: NXString Program;
            public: NXString User;
            public: NXString Machine;
            public: NXString Time;
            public: int Version;
            public: HistoryEventInformation() :
                Program(),
                User(),
                Machine(),
                Time(),
                Version()
            {
            }
            public: HistoryEventInformation(const NXString &programInitial ,
                    const NXString &userInitial ,
                    const NXString &machineInitial ,
                    const NXString &timeInitial ,
                    int versionInitial ) :
                Program(programInitial),
                User(userInitial),
                Machine(machineInitial),
                Time(timeInitial),
                Version(versionInitial)
{
            }
        };

        public: enum CloseModified
        {
            CloseModifiedUseResponses,
            CloseModifiedCloseModified,
            CloseModifiedDontCloseModified
        };

        public: enum CollaborativeContentType
        {
            CollaborativeContentTypeWorkset,
            CollaborativeContentTypeSubset,
            CollaborativeContentTypeShapeDesignElement,
            CollaborativeContentTypeOverridePart,
            CollaborativeContentTypeNotAssigned
        };

        public: enum PartPreview
        {
            PartPreviewNone,
            PartPreviewOnSave,
            PartPreviewOnDemand
        };

        public:
        struct TransientStatus
        {
            public: bool Trans;
            public: bool InitiallyTransient;
            public: bool Locked;
            public: bool TransientChildren;
            public: TransientStatus() :
                Trans(),
                InitiallyTransient(),
                Locked(),
                TransientChildren()
            {
            }
            public: TransientStatus(bool transInitial ,
                    bool initiallyTransientInitial ,
                    bool lockedInitial ,
                    bool transientChildrenInitial ) :
                Trans(transInitial),
                InitiallyTransient(initiallyTransientInitial),
                Locked(lockedInitial),
                TransientChildren(transientChildrenInitial)
            {
            }
        };

        public:
        struct IncompleteStatus
        {
            public: bool StructIncomplete;
            public: bool PendIncomplete;
            public: bool IncompleteChildren;
            public: IncompleteStatus() :
                StructIncomplete(),
                PendIncomplete(),
                IncompleteChildren()
            {
            }
            public: IncompleteStatus(bool structIncompleteInitial ,
                    bool pendIncompleteInitial ,
                    bool incompleteChildrenInitial ) :
                StructIncomplete(structIncompleteInitial),
                PendIncomplete(pendIncompleteInitial),
                IncompleteChildren(incompleteChildrenInitial)
            {
            }
        };
        private: BasePartImpl * m_basepart_impl;
        private: friend class  _BasePartBuilder;
        protected: BasePart();
        public: ~BasePart();
        public: NXString Leaf
        (
        );
        public: NXString FullPath
        (
        );
        public: NXOpen::BasePart::Units PartUnits
        (
        );
        public: NXOpen::PartSaveStatus * Save
        (
            NXOpen::BasePart::SaveComponents saveComponentParts ,
            NXOpen::BasePart::CloseAfterSave close 
        );
        public: NXOpen::PartSaveStatus * SaveAs
        (
            const NXString & newFileName 
        );
        NXOpen::PartSaveStatus * SaveAs
        (
            const char * newFileName 
        );
        public: void AssignPermanentName
        (
            const NXString & newFileName 
        );
        void AssignPermanentName
        (
            const char * newFileName 
        );
        public: NXOpen::BasePart * Reopen
        (
            NXOpen::BasePart::CloseWholeTree wholeTree ,
            NXOpen::BasePart::CloseModified closeModified ,
            NXOpen::PartCloseResponses * responses ,
            NXOpen::PartReopenReport ** reopenReport 
        );
        public: NXOpen::BasePart * ReopenAs
        (
            const NXString & fileName ,
            NXOpen::BasePart::CloseModified closeModified ,
            NXOpen::PartCloseResponses * responses ,
            NXOpen::PartReopenReport ** reopenReport 
        );
        NXOpen::BasePart * ReopenAs
        (
            const char * fileName ,
            NXOpen::BasePart::CloseModified closeModified ,
            NXOpen::PartCloseResponses * responses ,
            NXOpen::PartReopenReport ** reopenReport 
        );
        public: void Close
        (
            NXOpen::BasePart::CloseWholeTree wholeTree ,
            NXOpen::BasePart::CloseModified closeModified ,
            NXOpen::PartCloseResponses * responses 
        );

        public: void CloseAllConfigurations
        (
            NXOpen::BasePart::CloseWholeTree wholeTree ,
            NXOpen::BasePart::CloseModified closeModified ,
            NXOpen::PartCloseResponses * responses 
        );

        public: void CloseRetainUndoMarks
        (
            NXOpen::BasePart::CloseWholeTree wholeTree ,
            NXOpen::BasePart::CloseModified closeModified ,
            NXOpen::PartCloseResponses * responses 
        );
        public: bool IsFullyLoaded
        (
        );
        public: bool IsReadOnly
        (
        );
        public: bool IsModified
        (
        );
        public: bool HasWriteAccess
        (
        );
        public: NXOpen::PartLoadStatus * LoadFully
        (
        );
        public: NXOpen::PartLoadStatus * LoadThisPartFully
        (
        );
        public: NXOpen::PartLoadStatus * LoadThisPartPartially
        (
        );
        public: NXOpen::PartLoadStatus * LoadFeatureDataForSelection
        (
        );
        public: void ReverseBlankAll
        (
        );
        public: std::vector<NXOpen::BasePart::HistoryEventInformation> GetHistoryInformation
        (
        );
        public: NXOpen::BasePart::PartPreview PartPreviewMode
        (
        );
        public: void SetPartPreviewMode
        (
            NXOpen::BasePart::PartPreview mode 
        );
        public: void GetPreviewImage
        (
            int* width ,
            int* height ,
            std::vector<int> & pixels 
        );
        public: NXOpen::Assemblies::ComponentAssembly * ComponentAssembly
        (
        );
        public: void RemoveTransience
        (
        );
        public: void RemoveTransienceForSaveAs
        (
        );
        public: void ReinstateTransience
        (
        );
        public: NXOpen::BasePart::TransientStatus GetTransientStatus
        (
        );
        public: NXOpen::BasePart::IncompleteStatus GetIncompleteStatus
        (
        );
        public: void CompleteStructure
        (
        );
        public: NXOpen::Fields::FieldManager * FieldManager
        (
        );
        public: void SaveBookmark
        (
            const NXString & fileName ,
            NXOpen::BasePart::BookmarkOption option 
        );
        void SaveBookmark
        (
            const char * fileName ,
            NXOpen::BasePart::BookmarkOption option 
        );
        public: NX_DEPRECATED("Deprecated in NX6.0.0.  Use NXOpen::BasePart::DynamicSections instead.") NXOpen::Display::DynamicSectionBuilder * CreateDynamicSectionBuilder
        (
            bool loadFromView 
        );
        public: NXOpen::GroupBuilder * CreateGatewayGroupBuilder
        (
            NXOpen::Group * group 
        );
        public: NXOpen::Display::PerspectiveOptionsBuilder * CreatePerspectiveOptionsBuilder
        (
        );
        public: NXOpen::Display::FacetSettingsBuilder * CreateFacetSettingsBuilder
        (
        );
        public: bool SaveDisplayFacets
        (
        );
        public: void SetSaveDisplayFacets
        (
            bool saveDisplayFacets 
        );
        public: NX_DEPRECATED("Deprecated in NX11.0.0.  Use NXOpen::BasePart::RegenerateDisplayFacets overload instead.") void RegenerateDisplayFacets
        (
            bool regenerateChildren 
        );
        public: void RegenerateDisplayFacets
        (
            bool deleteSavedDisplayFacets ,
            bool regenerateChildren 
        );
        public: NXOpen::ReferenceSet * CreateReferenceSet
        (
        );
        public: void DeleteReferenceSet
        (
            NXOpen::ReferenceSet * referenceSetObject 
        );
        public: std::vector<NXOpen::ReferenceSet *> GetAllReferenceSets
        (
        );
        public: NXString UniqueIdentifier
        (
        );
        public: void SetUniqueIdentifier
        (
            const NXString & identifier 
        );
        void SetUniqueIdentifier
        (
            const char * identifier 
        );
        public: NXString GetMakeUniqueName
        (
        );
        public: void SetMakeUniqueName
        (
            const NXString & newUniqueName 
        );
        void SetMakeUniqueName
        (
            const char * newUniqueName 
        );
        public: NXOpen::EffectivityConditionBuilder * CreateEffectivityConditionBuilder
        (
            NXOpen::CollaborativeDesign * cd  ,
            const NXString & effectivityFormula 
        );
        NXOpen::EffectivityConditionBuilder * CreateEffectivityConditionBuilder
        (
            NXOpen::CollaborativeDesign * cd  ,
            const char * effectivityFormula 
        );
        public: NXOpen::EffectivityConditionBuilder * CreateEffectivityConditionBuilder
        (
            NXOpen::CollaborativeDesign * cd  ,
            const NXString & validationBasisFormula  ,
            const NXString & effectivityFormula 
        );
        NXOpen::EffectivityConditionBuilder * CreateEffectivityConditionBuilder
        (
            NXOpen::CollaborativeDesign * cd  ,
            const char * validationBasisFormula  ,
            const char * effectivityFormula 
        );
        public: NXOpen::BasePart::CollaborativeContentType GetCollaborativeContentType
        (
        );
        public: bool CanBeDisplayPart
        (
        );
        public: bool Displayed
        (
        );
        public: void Undisplay
        (
        );
        public: void GetArrangements
        (
            std::vector<NXOpen::Assemblies::Arrangement *> & arrangements 
        );
        public: NXOpen::PartLoadState PartLoadState
        (
        );
        public: bool HasAnyMinimallyLoadedChildren
        (
        );
        public: void GetMinimallyLoadedParts
        (
            std::vector<NXOpen::BasePart *> & minimallyLoadedParts 
        );
        public: void DeleteDisplayFacets
        (
            bool deleteSavedDisplayFacets ,
            bool processChildren 
        );
        public: bool IsDesignReviewPart
        (
        );
        public: NXOpen::Assemblies::PartitionSchemeManager * PartitionSchemeManager
        (
        );

        public: std::vector<NXOpen::ConfiguredPart *> GetConfiguredParts
        (
        );

        public: NXOpen::WCS *WCS();
        public: NXOpen::ArcCollection *Arcs();
        public: NXOpen::ParabolaCollection *Parabolas();
        public: NXOpen::GeometricAnalysis::AnalysisManager *AnalysisManager();
        public: NXOpen::MeasureManager *MeasureManager();
        public: NXOpen::Layer::LayerManager *Layers();
        public: NXOpen::XformCollection *Xforms();
        public: NXOpen::OffsetCollection *Offsets();
        public: NXOpen::PlaneCollection *Planes();
        public: NXOpen::HyperbolaCollection *Hyperbolas();
        public: NXOpen::CurveCollection *Curves();
        public: NXOpen::PointCollection *Points();
        public: NXOpen::EllipseCollection *Ellipses();
        public: NXOpen::LineCollection *Lines();
        public: NXOpen::InfiniteLineCollection *InfiniteLines();
        public: NXOpen::SplineCollection *Splines();
        public: NXOpen::PolylineCollection *Polylines();
        public: NXOpen::NXMatrixCollection *NXMatrices();
        public: NXOpen::ScalarCollection *Scalars();
        public: NXOpen::FontCollection *Fonts();
        public: NXOpen::DatumCollection *Datums();
        public: NXOpen::ViewCollection *Views();
        public: NXOpen::ExpressionGroupCollection *ExpressionGroups();
        public: NXOpen::ExpressionCollection *Expressions();
        public: NXOpen::ParameterTableCollection *ParameterTables();
        public: NXOpen::UnitCollection *UnitCollection();
        public: NXOpen::DirectionCollection *Directions();
        public: NXOpen::ModelingViewCollection *ModelingViews();
        public: NXOpen::Layer::CategoryCollection *LayerCategories();
        public: NXOpen::RuleManager *RuleManager();
        public: NXOpen::Preferences::PartPreferences *Preferences();
        public: NXOpen::AxisCollection *Axes();
        public: NXOpen::LightCollection *Lights();
        public: NXOpen::SectionCollection *Sections();
        public: NXOpen::ScCollectorCollection *ScCollectors();
        public: NXOpen::ScRuleFactory *ScRuleFactory();
        public: NXOpen::CoordinateSystemCollection *CoordinateSystems();
        public: NXOpen::LayoutCollection *Layouts();
        public: NXOpen::PDM::PdmPart *PDMPart();
        public: NXOpen::Display::CameraCollection *Cameras();
        public: NXOpen::Display::AnimationCameraCollection *AnimationCameras();
        public: NXOpen::Display::DynamicSectionCollection *DynamicSections();
        public: NXOpen::Display::DecalCollection *Decals();
        public: NXOpen::UserDefinedObjects::UserDefinedObjectManager *UserDefinedObjectManager();
        public: NXOpen::CAE::FunctionCollection *Functions();
        public: NXOpen::CAE::ViewLayoutManager *CaeViewLayoutManager();
        public: NXOpen::CAE::PostScenarioManager *PostScenarioMgr();
        public: NXOpen::Display::SelPrefCollection *SelPref();
        public: NXOpen::PlotManager *PlotManager();
        public: NXOpen::PropertiesManager *PropertiesManager();
        public: NXOpen::Features::BaseFeatureCollection *BaseFeatures();
        public: NXOpen::Features::FeatureCollection *Features();
        public: NXOpen::ColorManager *Colors();
        public: NXOpen::Optimization::OptimizationCollection *Optimization();
        public: NXOpen::MaterialManager *MaterialManager();
        public: NXOpen::Optimization::DesignStudyCollection *DesignStudy();
        public: NXOpen::PartSaveOptions *SaveOptions();
        public: NXOpen::ValidationCollection *Validations();
        public: NXOpen::Assemblies::ProductOutlineManager *Assemblies();
        public: NXOpen::Assemblies::AssemblyManager *AssemblyManager();
        public: NXOpen::Display::TrueShadingCollection *SHEDObjs();
        public: NXOpen::Display::TrueStudioCollection *TrueStudioObjs();
        public: NXOpen::Display::GridCollection *Grids();
        public: NXOpen::Gateway::ImageCaptureManager *ImageCaptureManager();
        public: NXOpen::CAM::CAMFeatureCollection *CAMFeatures();
        public: NXOpen::Validate::RequirementCheckCollection *RequirementChecks();
        public: NXOpen::Validate::RequirementCollection *Requirements();
        public: NXOpen::Display::ImageCollection *Images();
        public: NXOpen::Display::ImageDataCollection *ImagesData();
        public: NXOpen::Drawings::ConvertToPMIBuilderManager *ConvertToPMIBuilderManager();
        public: NXOpen::Display::PointCloudCollection *PointClouds();
        public: NXOpen::Annotations::AnnotationManager *Annotations();
        public: NXOpen::ParamLibParameterLibraryManager *ParameterLibraryManager();
        public: NXOpen::ExternalFileReferenceManager *ExternalFileReferenceManager();
        public: NXOpen::Validate::AnalysisResultCollection *AnalysisResults();
        public: NXOpen::Validate::PersistentResultCollection *PersistentResults();

        public: NXOpen::Markup::MarkupCollection *Markups();

        public: NXOpen::ViewSetCollection *ViewSets();
        public: NXOpen::Implicit::ImplicitOperationCollection *ImplictOperations();
        public: NXOpen::StrokeCollection *Strokes();

        public: NXOpen::MendixReporting::CheckerData *CheckerData();

        public: NXOpen::MendixReporting::CadInfoManager *CadInfoManager();

        public: NXOpen::Display::UVMapCollection *UVMaps();
        public: NXOpen::GeometricAnalysis::AnalysisResultCollection *GeometricAnalysisAnalysisResultCollection();
        public: NXOpen::Features::SelectionProgramCollection *SelectionProgramCollections();
        public: NXOpen::CAE::LayoutStateCollection *LayoutStates();
        public: NXOpen::CAE::LayoutStatePreferences *LayoutStatePreferences();
        public: NXOpen::CAE::CurveOperationExpressionRecordCollection *CurveOperationExpRecords();
        public: NXOpen::UserDefinedTemplate::ConfigurationManager *ConfigurationManager();
        public: NXOpen::DesignSimulation::PostManager *PostManager();
        public: NXOpen::Display::VisualMaterialCollection *VisualMaterialCollection();
    };
}
#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