PartCollection.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  JA API的C++接口头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     PartCollection.ja
//
//  生成工具:
//     apiwrap
//
//  警告:
//    此文件为自动生成，请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <iterator>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/BasePart.hxx>
#include <NXOpen/CloudDM_NewPartBuilder.hxx>
#include <NXOpen/Gateway_GenericFileNewBuilder.hxx>
#include <NXOpen/LinkedMirrorPartBuilder.hxx>
#include <NXOpen/TaggedObjectCollection.hxx>
#include <NXOpen/Part.hxx>
#include <NXOpen/PartCloseResponses.hxx>
#include <NXOpen/PartLoadStatus.hxx>
#include <NXOpen/PartReopenReport.hxx>
#include <NXOpen/PartSaveStatus.hxx>
#include <NXOpen/PartTypes.hxx>
#include <NXOpen/TaggedObject.hxx>
#include <NXOpen/ugmath.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 PartCollection;
    class Session;
    class BasePart;
    namespace Assemblies
    {
        class Component;
    }
    namespace CloudDM
    {
        class NewPartBuilder;
    }
    class FileNew;
    namespace Gateway
    {
        class GenericFileNewBuilder;
    }
    class LinkedMirrorPartBuilder;
    class LoadOptions;
    namespace PDM
    {
        class PartManager;
    }
    class Part;
    class PartCloseResponses;
    class PartLoadStatus;
    class PartReopenReport;
    class PartSaveStatus;
    class SaveOptions;
    namespace ShapeSearch
    {
        class SearchManager;
    }
    class PartCollectionImpl;
    class NXOPENCPPEXPORT  PartCollection : public NXOpen::TaggedObjectCollection
    {
        public: enum SdpsStatus
        {
            SdpsStatusOk,
            SdpsStatusOutsideModelling,
            SdpsStatusDrawingDisplayed,
            SdpsStatusInPartsList,
            SdpsStatusGdt,
            SdpsStatusUnitsMismatch
        };

        public: enum RefsetOption
        {
            RefsetOptionEntire,
            RefsetOptionCurrent,
            RefsetOptionPreserveRefset
        };

        public: enum WorkComponentOption
        {
            WorkComponentOptionVisible,
            WorkComponentOptionGiven
        };

        public: enum DesignWorksetIntentType
        {
            DesignWorksetIntentTypeMultipleProduct,
            DesignWorksetIntentTypeMultipleConfiguration
        };
        public: 
        typedef NXOpen::Callback1<void, NXOpen::BasePart *> PartCreatedHandler;
        public: 
        typedef NXOpen::Callback1<void, NXOpen::BasePart *> PartOpenedHandler;
        public: 
        typedef NXOpen::Callback1<void, NXOpen::BasePart *> PartSavedHandler;
        public: 
        typedef NXOpen::Callback1<void, NXOpen::BasePart *> PartSavedAsHandler;
        public: 
        typedef NXOpen::Callback1<void, NXOpen::BasePart *> PartClosedHandler;
        public: 
        typedef NXOpen::Callback1<void, NXOpen::BasePart *> PartModifiedHandler;
        public: 
        typedef NXOpen::Callback1<void, NXOpen::BasePart *> PartRenamedHandler;
        public: 
        typedef NXOpen::Callback1<void, NXOpen::BasePart *> WorkPartChangedHandler;
        public: enum SetProtectionOn
        {
            SetProtectionOnDisplayedPart,
            SetProtectionOnDisplayedPartandComponents,
            SetProtectionOnAllParts
        };

        public: enum MultipleDisplayedPartStatus
        {
            MultipleDisplayedPartStatusEnabled,
            MultipleDisplayedPartStatusDisabledByCustomer,
            MultipleDisplayedPartStatusDisabled
        };
        private: PartCollectionImpl * m_partcollection_impl;
        private: NXOpen::Session* m_owner;
        public: explicit PartCollection(NXOpen::Session *owner);
        public:
        tag_t Tag() const;
        public: ~PartCollection();
        //lint -sem(NXOpen::PartCollection::iterator::copy,initializer)
        class iterator : public std::iterator<std::forward_iterator_tag, NXOpen::BasePart *>
        {
        public:
            iterator() : m_context(nullptr), m_current(NULL_TAG)
            {
                // coverity[uninit_member]
            } //lint !e1401 m_state is not initialized

            explicit iterator(NXOpen::PartCollection *context) : m_context(context), m_current(NULL_TAG)
            {
                // coverity[uninit_member]
            }//lint !e1401 m_state is not initialized

            iterator(const iterator &other): m_context(nullptr), m_current(NULL_TAG)
            {
                copy(other);
            }

            iterator &operator =(const iterator &other)
            {
                if (&other != this)
                    copy(other);
                return *this;
            }

            bool operator ==(const iterator &other) const
            {
                return m_current == other.m_current && m_context == other.m_context;
            }

            bool operator !=(const iterator &other) const
            {
                return !operator == (other);
            }

            NXOPENCPPEXPORT  value_type operator * () const;
            iterator & operator ++()
{
                next();
                return *this;
            }

            iterator operator ++(int)
            {
                iterator tmp(*this);
                ++*this;
                return tmp;
            }
        private:
            void copy(const iterator &other)
            {
                m_context = other.m_context;
                m_current = other.m_current;
                for (int i = 0; i < sizeof(m_state)/sizeof(m_state[0]); i++)
                     m_state[i] = other.m_state[i];
            }
            NXOPENCPPEXPORT  void next();
            NXOpen::PartCollection *m_context;
            tag_t m_current;
            unsigned int m_state[8];
        };

        iterator begin();
        iterator end()
        {
            return iterator(this);
        }

        public: NXOpen::BasePart * FindObject
        (
            const NXString & name 
        );
        NXOpen::BasePart * FindObject
        (
            const char * name 
        );
        public: NXOpen::Part * NewDisplay
        (
            const NXString & name ,
            NXOpen::Part::Units units 
        );
        NXOpen::Part * NewDisplay
        (
            const char * name ,
            NXOpen::Part::Units units 
        );
        public: NXOpen::BasePart * NewBaseDisplay
        (
            const NXString & name ,
            NXOpen::BasePart::Units units 
        );
        NXOpen::BasePart * NewBaseDisplay
        (
            const char * name ,
            NXOpen::BasePart::Units units 
        );
        public: NXOpen::BasePart * NewBase
        (
            const NXString & name ,
            NXOpen::BasePart::Units units 
        );
        NXOpen::BasePart * NewBase
        (
            const char * name ,
            NXOpen::BasePart::Units units 
        );
        public: NXOpen::Part * Open
        (
            const NXString & filename  ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        NXOpen::Part * Open
        (
            const char * filename  ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        public: NXOpen::BasePart * OpenBase
        (
            const NXString & filename  ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        NXOpen::BasePart * OpenBase
        (
            const char * filename  ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        public: NXOpen::Part * OpenDisplay
        (
            const NXString & filename  ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        NXOpen::Part * OpenDisplay
        (
            const char * filename  ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        public: NXOpen::BasePart * OpenActiveDisplay
        (
            const NXString & filename  ,
            NXOpen::DisplayPartOption displayPartOption ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        NXOpen::BasePart * OpenActiveDisplay
        (
            const char * filename  ,
            NXOpen::DisplayPartOption displayPartOption ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        public: NXOpen::BasePart * OpenBaseDisplay
        (
            const NXString & filename  ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        NXOpen::BasePart * OpenBaseDisplay
        (
            const char * filename  ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        public: void SaveAll
        (
            bool* anyPartsModified ,
            NXOpen::PartSaveStatus ** saveStatus 
        );
        public: void CloseAll
        (
            NXOpen::BasePart::CloseModified closeModified ,
            NXOpen::PartCloseResponses * responses 
        );
        public: NXOpen::PartReopenReport * ReopenAll
        (
            NXOpen::BasePart::CloseModified closeModified ,
            NXOpen::PartCloseResponses * responses 
        );
        public: NXOpen::Part * Work
        (
        );
        public: NXOpen::BasePart * BaseWork
        (
        );
        public: NXOpen::Part * Display
        (
        );
        public: NXOpen::BasePart * BaseDisplay
        (
        );
        public: std::vector<NXOpen::BasePart *> GetDisplayedParts
        (
        );
        public: void SetWork
        (
            NXOpen::BasePart * part 
        );
        public: NXOpen::Assemblies::Component * WorkComponent
        (
        );
        public: void SetWorkComponent
        (
            NXOpen::Assemblies::Component * workComponent ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        public: void SetWorkComponent
        (
            NXOpen::Assemblies::Component * workComponent ,
            NXOpen::PartCollection::RefsetOption refsetOption ,
            NXOpen::PartCollection::WorkComponentOption visibility ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        public: NXOpen::PartLoadStatus * SetWorkComponentOverride
        (
            NXOpen::Assemblies::Component * workComponent 
        );
        public: NXOpen::PartCollection::SdpsStatus SetDisplay
        (
            NXOpen::BasePart * part ,
            bool maintainWorkPart ,
            bool setEntirePart ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        public: NXOpen::PartCollection::SdpsStatus SetActiveDisplay
        (
            NXOpen::BasePart * part ,
            NXOpen::DisplayPartOption displayPartOption ,
            NXOpen::PartDisplayPartWorkPartOption workPartOption ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        public: NXOpen::PartCollection::SdpsStatus SetActiveDisplayRetainUndoMarks
        (
            NXOpen::BasePart * part ,
            NXOpen::DisplayPartOption displayPartOption ,
            NXOpen::PartDisplayPartWorkPartOption workPartOption ,
            NXOpen::PartLoadStatus ** loadStatus 
        );
        public: NXOpen::PartCloseResponses * NewPartCloseResponses
        (
        );
        public: NXOpen::FileNew * FileNew
        (
        );
        public: int AddPartCreatedHandler
        (
            const NXOpen::PartCollection::PartCreatedHandler&  handler 
        );
        public: void RemovePartCreatedHandler
        (
            int id 
        );
        public: int AddPartOpenedHandler
        (
            const NXOpen::PartCollection::PartOpenedHandler&  handler 
        );
        public: void RemovePartOpenedHandler
        (
            int id 
        );
        public: int AddPartSavedHandler
        (
            const NXOpen::PartCollection::PartSavedHandler&  handler 
        );
        public: void RemovePartSavedHandler
        (
            int id 
        );
        public: int AddPartSavedAsHandler
        (
            const NXOpen::PartCollection::PartSavedAsHandler&  handler 
        );
        public: void RemovePartSavedAsHandler
        (
            int id 
        );
        public: int AddPartClosedHandler
        (
            const NXOpen::PartCollection::PartClosedHandler&  handler 
        );
        public: void RemovePartClosedHandler
        (
            int id 
        );
        public: int AddPartModifiedHandler
        (
            const NXOpen::PartCollection::PartModifiedHandler&  handler 
        );
        public: void RemovePartModifiedHandler
        (
            int id 
        );
        public: int AddPartRenamedHandler
        (
            const NXOpen::PartCollection::PartRenamedHandler&  handler 
        );
        public: void RemovePartRenamedHandler
        (
            int id 
        );
        public: int AddWorkPartChangedHandler
        (
            const NXOpen::PartCollection::WorkPartChangedHandler&  handler 
        );
        public: void RemoveWorkPartChangedHandler
        (
            int id 
        );
        public: NXOpen::PartSaveStatus * ForceSaveAll
        (
        );
        public: void SetSeedPartTemplateData
        (
            const NXString & filename ,
            const NXString & templateName ,
            bool addMaster 
        );
        void SetSeedPartTemplateData
        (
            const char * filename ,
            const char * templateName ,
            bool addMaster 
        );
        public: void OpenSeedPartBlankTemplate
        (
            const NXString & filename ,
            bool addMaster 
        );
        void OpenSeedPartBlankTemplate
        (
            const char * filename ,
            bool addMaster 
        );
        public: void SetNonmasterSeedPartData
        (
            const NXString & filename 
        );
        void SetNonmasterSeedPartData
        (
            const char * filename 
        );
        public: NXOpen::LinkedMirrorPartBuilder * CreateLinkedMirrorPartBuilder
        (
            NXOpen::Part * part 
        );
        public: bool IsMirroredPart
        (
            NXOpen::Part * part 
        );
        public: bool IsExactMirroredPart
        (
            NXOpen::Part * part 
        );
        public: void SetMirrorPartType
        (
            NXOpen::Part * part ,
            NXOpen::LinkedMirrorPartBuilder::MirrorPartTypeOption mirrorOption 
        );
        public: NXOpen::LinkedMirrorPartBuilder::MirrorPartTypeOption GetMirrorPartType
        (
            NXOpen::Part * part 
        );
        public: NXString GetSourcePartNameOfMirrorPart
        (
            NXOpen::Part * mirrorPart 
        );
        public: NX_DEPRECATED("Deprecated in NX11.0.0.  Use overloaded SetPassword instead.") void SetPassword
        (
            NXOpen::Part * part  ,
            const NXString & uAdminPassword ,
            const NXString & uReadPassword ,
            const NXString & uWritePassword ,
            const NXString & uFullControlPassword 
        );
        void SetPassword
        (
            NXOpen::Part * part  ,
            const char * uAdminPassword ,
            const char * uReadPassword ,
            const char * uWritePassword ,
            const char * uFullControlPassword 
        );
        public: NX_DEPRECATED("Deprecated in NX11.0.0.  Use overloaded RemovePassword instead.") void RemovePassword
        (
            NXOpen::Part * part 
        );
        public: void SetOpenPassword
        (
            const NXString & fileName  ,
            const NXString & password 
        );
        void SetOpenPassword
        (
            const char * fileName  ,
            const char * password 
        );
        public: NXOpen::Part * ImportToolDesignPackage
        (
            const NXString & filename ,
            const NXString & outputDirectory ,
            NXOpen::PartLoadStatus ** loadStatus ,
            NXOpen::PartSaveStatus ** saveStatus 
        );
        NXOpen::Part * ImportToolDesignPackage
        (
            const char * filename ,
            const char * outputDirectory ,
            NXOpen::PartLoadStatus ** loadStatus ,
            NXOpen::PartSaveStatus ** saveStatus 
        );
        public: NXOpen::LinkedMirrorPartBuilder::MirrorCsysOption GetMirrorCsysOptionOfMirrorPart
        (
            NXOpen::Part * part 
        );
        public: void GetMirrorPlaneDataOfMirrorPart
        (
            NXOpen::Part * part ,
            NXOpen::Point3d* mirrorPlaneOrigin ,
            NXOpen::Vector3d* mirrorPlaneDirection 
        );
        public: void SolveAllPostponedConstraints
        (
        );
        public: NX_DEPRECATED("Deprecated in NX12.0.0.  A direct call to refresh the part navigator should not be needed.") void RefreshPartNavigator
        (
        );
        public: NXOpen::Gateway::GenericFileNewBuilder * CreateGenericFileNewBuilder
        (
        );
        public: void OpenPasswordSafe
        (
            const NXString & fileName  ,
            const NXString & password 
        );
        void OpenPasswordSafe
        (
            const char * fileName  ,
            const char * password 
        );
        public: void ClosePasswordSafe
        (
        );
        public: void SetPassword
        (
            NXOpen::Part * part  ,
            const NXString & adminPassword ,
            const NXString & readPassword ,
            const NXString & writePassword ,
            const NXString & fullControlPassword ,
            NXOpen::PartCollection::SetProtectionOn partoption 
        );
        void SetPassword
        (
            NXOpen::Part * part  ,
            const char * adminPassword ,
            const char * readPassword ,
            const char * writePassword ,
            const char * fullControlPassword ,
            NXOpen::PartCollection::SetProtectionOn partoption 
        );
        public: void RemovePassword
        (
            NXOpen::Part * part  ,
            NXOpen::PartCollection::SetProtectionOn partoption 
        );
        public: NXOpen::PartCollection::MultipleDisplayedPartStatus AllowMultipleDisplayedParts
        (
        );
        public: void SetAllowMultipleDisplayedParts
        (
            bool additionalPartsDisplayed 
        );
        public: NXOpen::PartLoadStatus * EnsurePartsLoadedPartially
        (
            const std::vector<NXOpen::BasePart *> & parts  ,
            bool includeChildren 
        );
        public: NXOpen::PartLoadStatus * EnsurePartsLoadedFully
        (
            const std::vector<NXOpen::BasePart *> & parts  ,
            bool includeChildren 
        );
        public: NXOpen::PartLoadState GetPartLoadStateOfFileName
        (
            const NXString & fileName 
        );
        NXOpen::PartLoadState GetPartLoadStateOfFileName
        (
            const char * fileName 
        );

        public: NXOpen::CloudDM::NewPartBuilder * CreateCloudDMNewPartBuilder
        (
        );

        public: NXOpen::PartCollection::DesignWorksetIntentType IntentForWorksetWithoutNxDataset
        (
        );

        public: void SetIntentForWorksetWithoutNxDataset
        (
            NXOpen::PartCollection::DesignWorksetIntentType intent 
        );

        public: NXOpen::LoadOptions *LoadOptions();
        public: NXOpen::SaveOptions *SaveOptions();
        public: NXOpen::PDM::PartManager *PDMPartManager();
        public: NXOpen::ShapeSearch::SearchManager *ShapeSearchManager();
    }; //lint !e1712 default constructor not defined for class
}
#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