Assemblies_ComponentAssembly.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  C++接口到JA API的头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     Assemblies_ComponentAssembly.ja
//
//  生成工具:
//     apiwrap
//
//  警告:
//    此文件为自动生成 - 请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/Assemblies_Component.hxx>
#include <NXOpen/BasePart.hxx>
#include <NXOpen/ErrorList.hxx>
#include <NXOpen/NXObject.hxx>
#include <NXOpen/PartCloseStatus.hxx>
#include <NXOpen/PartLoadStatus.hxx>
#include <NXOpen/ugmath.hxx>
#include <NXOpen/libnxopencpp_assemblies_exports.hxx>
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4996)
#endif
#ifdef __GNUC__
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
namespace NXOpen
{
    namespace Assemblies
    {
        class ComponentAssembly;
    }
    namespace Assemblies
    {
        class Arrangement;
    }
    namespace Assemblies
    {
        class ArrangementCollection;
    }
    namespace Assemblies
    {
        class ClearanceSetCollection;
    }
    namespace Assemblies
    {
        class Component;
    }
    namespace Assemblies
    {
        class ComponentOrder;
    }
    namespace Assemblies
    {
        class ComponentPattern;
    }
    namespace Assemblies
    {
        class ComponentPatternBuilder;
    }
    namespace Assemblies
    {
        class ComponentPatternCollection;
    }
    namespace Assemblies
    {
        class DrawingExplosionCollection;
    }
    namespace Assemblies
    {
        class ExplosionCollection;
    }
    namespace Assemblies
    {
        class Order;
    }
    namespace Assemblies
    {
        class OrderCollection;
    }
    namespace Assemblies
    {
        class SubsetCollection;
    }
    class BasePart;
    class ErrorList;
    class Expression;
    class NXObject;
    class Part;
    class PartCloseStatus;
    class PartLoadStatus;
    namespace Positioning
    {
        class ComponentConstraintGroup;
    }
namespace Positioning
    {
        class ComponentConstraintGroupBuilder;
    }
    namespace Positioning
    {
        class ComponentPositioner;
    }
    namespace Positioning
    {
        class MatingConverter;
    }
    class View;
    namespace Assemblies
    {
        class _ComponentAssemblyBuilder;
        class ComponentAssemblyImpl;
        class NXOPENCPP_ASSEMBLIESEXPORT  ComponentAssembly : public NXOpen::NXObject
        {
            public: enum SubstitutionMode
            {
                SubstitutionModeNonAssociative,
                SubstitutionModeSingleComponent,
                SubstitutionModeAll
            };

            public: enum OpenOption
            {
                OpenOptionComponentOnly,
                OpenOptionImmediateChildren,
                OpenOptionWholeAssembly,
                OpenOptionReapplyRevRule
            };

            public: enum OpenComponentStatus
            {
                OpenComponentStatusSuccessfullyOpened,
                OpenComponentStatusDeletedByOpen,
                OpenComponentStatusCouldNotOpen
            };

            public: enum CheckinCheckoutOption
            {
                CheckinCheckoutOptionDesignElement,
                CheckinCheckoutOptionSourceItem,
                CheckinCheckoutOptionBoth,
                CheckinCheckoutOptionDefault
            };

            public: enum CloseModified
            {
                CloseModifiedFalse,
                CloseModifiedTrue
            };

            public: enum SuppressedState
            {
                SuppressedStateInherit,
                SuppressedStateSuppressed,
                SuppressedStateUnsuppressed,
                SuppressedStateSuppressedByExp,
                SuppressedStateUnsuppressedByExp
            };

            public: enum OrderTargetLocation
            {
                OrderTargetLocationPlaceBefore,
                OrderTargetLocationPlaceAfter
            };
            private: ComponentAssemblyImpl * m_componentassembly_impl;
            private: friend class  _ComponentAssemblyBuilder;
            protected: ComponentAssembly();
public: ~ComponentAssembly();
            public: NXOpen::Assemblies::Component * AddComponent
            (
                const NXString & partToAdd ,
                const NXString & referenceSetName ,
                const NXString & componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus 
            );
            NXOpen::Assemblies::Component * AddComponent
            (
                const char * partToAdd ,
                const char * referenceSetName ,
                const char * componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus 
            );
            public: NXOpen::Assemblies::Component * AddComponent
            (
                const NXString & partToAdd ,
                const NXString & referenceSetName ,
                const NXString & componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus ,
                bool uomAsNgc 
            );
            NXOpen::Assemblies::Component * AddComponent
            (
                const char * partToAdd ,
                const char * referenceSetName ,
                const char * componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus ,
                bool uomAsNgc 
            );
            public: void AddComponents
            (
                const std::vector<NXOpen::Part *> & partsToAdd ,
                const NXOpen::Point3d & point ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                const NXString & referenceSetName ,
                int count ,
                bool scatter ,
                std::vector<NXOpen::Assemblies::Component *> & components 
            );
            void AddComponents
            (
                const std::vector<NXOpen::Part *> & partsToAdd ,
                const NXOpen::Point3d & point ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                const char * referenceSetName ,
                int count ,
                bool scatter ,
                std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: NXOpen::Assemblies::Component * AddComponent
            (
                NXOpen::BasePart * partToAdd ,
                const NXString & referenceSetName ,
                const NXString & componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus 
            );
            NXOpen::Assemblies::Component * AddComponent
            (
                NXOpen::BasePart * partToAdd ,
                const char * referenceSetName ,
                const char * componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus 
            );
            public: NXOpen::Assemblies::Component * AddMasterPartComponent
            (
                const NXString & partToAdd ,
                const NXString & referenceSetName ,
                const NXString & componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus 
            );
            NXOpen::Assemblies::Component * AddMasterPartComponent
            (
                const char * partToAdd ,
                const char * referenceSetName ,
                const char * componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus 
            );
            public: NXOpen::Assemblies::Component * AddMasterPartComponent
            (
                NXOpen::Part * partToAdd ,
                const NXString & referenceSetName ,
                const NXString & componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus 
            );
            NXOpen::Assemblies::Component * AddMasterPartComponent
            (
                NXOpen::Part * partToAdd ,
                const char * referenceSetName ,
                const char * componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus 
            );
            public: NXOpen::Assemblies::Component * InsertProduct
            (
                NXOpen::Part * productPart ,
                int layer ,
                NXOpen::PartLoadStatus ** loadStatus 
            );
            public: NXOpen::Assemblies::Component * RootComponent
            (
            );
            public: NXOpen::Assemblies::Component * SubstituteComponent
            (
                NXOpen::Assemblies::Component * component ,
                NXOpen::BasePart * part ,
                const NXString & newName ,
                const NXString & referenceSet ,
                int layer ,
                NXOpen::Assemblies::ComponentAssembly::SubstitutionMode mode 
            );
            NXOpen::Assemblies::Component * SubstituteComponent
            (
                NXOpen::Assemblies::Component * component ,
                NXOpen::BasePart * part ,
                const char * newName ,
                const char * referenceSet ,
                int layer ,
                NXOpen::Assemblies::ComponentAssembly::SubstitutionMode mode 
            );
            public: void RemoveComponent
            (
                NXOpen::Assemblies::Component * component 
            );
            public: NXOpen::Assemblies::Component * MapComponentFromParent
            (
                NXOpen::Assemblies::Component * component 
            );
            public: std::vector<NXOpen::Assemblies::Component *> MapComponentsFromSubassembly
            (
                NXOpen::Assemblies::Component * component 
            );
            public: NXOpen::Assemblies::Arrangement * ActiveArrangement
            (
            );
            public: void SetActiveArrangement
            (
                NXOpen::Assemblies::Arrangement * newArrangement 
            );
            public: void ChangeByName
            (
                const NXString & name ,
                const std::vector<NXOpen::Assemblies::Component *> & partOccs 
            );
            void ChangeByName
            (
                const char * name ,
                const std::vector<NXOpen::Assemblies::Component *> & partOccs 
            );
            public: void SetDefault
            (
                NXOpen::Assemblies::Arrangement * arrangement 
            );
            public: NXOpen::ErrorList * SuppressComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                const std::vector<NXOpen::Assemblies::Arrangement *> & arrangements 
            );
            public: NXOpen::ErrorList * SuppressComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: NXOpen::ErrorList * SuppressComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                const std::vector<NXOpen::Assemblies::Arrangement *> & arrangements ,
                const NXString & expression 
            );
            NXOpen::ErrorList * SuppressComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                const std::vector<NXOpen::Assemblies::Arrangement *> & arrangements ,
                const char * expression 
            );
            public: NXOpen::ErrorList * UnsuppressComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                const std::vector<NXOpen::Assemblies::Arrangement *> & arrangements 
            );
            public: NXOpen::ErrorList * UnsuppressComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: NXOpen::ErrorList * ReleaseSuppression
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                const std::vector<NXOpen::Assemblies::Arrangement *> & arrangements 
            );
            public: NXOpen::ErrorList * ReleaseSuppression
            (
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: void SetEntirePartRefset
            (
                NXOpen::Assemblies::Component * component 
            );
            public: void SetEmptyRefset
            (
                NXOpen::Assemblies::Component * component 
            );
            public: NXOpen::ErrorList * ReplaceReferenceSetInOwners
            (
                const NXString & newReferenceSet ,
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            NXOpen::ErrorList * ReplaceReferenceSetInOwners
            (
                const char * newReferenceSet ,
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: void ReplaceReferenceSet
            (
                NXOpen::Assemblies::Component * component ,
                const NXString & newReferenceSet 
            );
            void ReplaceReferenceSet
            (
                NXOpen::Assemblies::Component * component ,
                const char * newReferenceSet 
            );
            public: void MoveComponent
            (
                NXOpen::Assemblies::Component * component ,
                const NXOpen::Vector3d & translation ,
                const NXOpen::Matrix3x3 & rotation 
            );
            public: NXOpen::Positioning::ComponentPositioner * Positioner
            (
            );
            public: NXOpen::Positioning::MatingConverter * CreateMatingConverter
            (
            );
            public: void DeleteMatingConditions
            (
            );
            public: void ConvertRememberedMcs
            (
            );
            public: void SetNonGeometricState
            (
                NXOpen::Assemblies::Component * component ,
                bool nonGeometricState 
            );
            public: bool GetNonGeometricState
            (
                NXOpen::Assemblies::Component * component 
            );
            public: NXOpen::Assemblies::ComponentQuantity GetComponentQuantityType
            (
                NXOpen::Assemblies::Component * component 
            );
            public: void SetIntegerQuantity
            (
                NXOpen::Assemblies::Component * component ,
                int integerQuantity 
            );
            public: int GetIntegerQuantity
            (
                NXOpen::Assemblies::Component * component 
            );
            public: void SetRealQuantity
            (
                NXOpen::Assemblies::Component * component ,
                double realQuantity ,
                const NXString & quantityUnits 
            );
            void SetRealQuantity
            (
                NXOpen::Assemblies::Component * component ,
                double realQuantity ,
                const char * quantityUnits 
            );
            public: double GetRealQuantity
            (
                NXOpen::Assemblies::Component * component ,
                NXString* units 
            );
            public: void SetAsRequiredQuantity
            (
                NXOpen::Assemblies::Component * component 
            );
            public: NXString GetAsRequiredQuantity
            (
                NXOpen::Assemblies::Component * component 
            );
            public: std::vector<NXOpen::Assemblies::Component *> CopyComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: void RestructureComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & origComponents ,
                NXOpen::Assemblies::Component * newParentComponent ,
                bool deleteFlag ,
                std::vector<NXOpen::Assemblies::Component *> & newComponents ,
                NXOpen::ErrorList ** errorList 
            );
            public: NXOpen::PartLoadStatus * OpenComponents
            (
                NXOpen::Assemblies::ComponentAssembly::OpenOption openOption ,
                const std::vector<NXOpen::Assemblies::Component *> & componentsToOpen ,
                std::vector<NXOpen::Assemblies::ComponentAssembly::OpenComponentStatus> & openStatus 
            );
            public: NXOpen::PartCloseStatus * CloseComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & componentsToClose ,
                NXOpen::BasePart::CloseWholeTree wholeTree ,
                NXOpen::Assemblies::ComponentAssembly::CloseModified closeModified 
            );
            public: NXOpen::Expression * GetSuppressionExpression
            (
                NXOpen::Assemblies::Component * component 
            );
            public: NXOpen::Expression * GetSuppressionExpression
            (
                NXOpen::Assemblies::Component * component ,
                NXOpen::Assemblies::Arrangement * arrangement 
            );
            public: NXOpen::Assemblies::ComponentAssembly::SuppressedState GetSuppressedState
            (
                NXOpen::Assemblies::Component * component ,
                bool* controlled 
            );
            public: NXOpen::Assemblies::ComponentAssembly::SuppressedState GetSuppressedState
            (
                NXOpen::Assemblies::Component * component ,
                NXOpen::Assemblies::Arrangement * arrangement ,
                bool* controlled 
            );
            public: NXOpen::Assemblies::ComponentPatternBuilder * CreateComponentPatternBuilder
            (
                NXOpen::Assemblies::ComponentPattern * compPattern 
            );
            public: NXOpen::PartLoadStatus * AddPendingComponent
            (
                const NXString & partToAdd ,
                NXOpen::NXObject * pendingComponent ,
                const NXString & referenceSetName ,
                const NXString & componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                bool uomAsNgc 
            );
            NXOpen::PartLoadStatus * AddPendingComponent
            (
                const char * partToAdd ,
                NXOpen::NXObject * pendingComponent ,
                const char * referenceSetName ,
                const char * componentName ,
                const NXOpen::Point3d & basePoint ,
                const NXOpen::Matrix3x3 & orientation ,
                int layer ,
                bool uomAsNgc 
            );
            public: NXOpen::Positioning::ComponentConstraintGroupBuilder * CreateConstraintGroupBuilder
            (
                NXOpen::Positioning::ComponentConstraintGroup * group ,
                NXOpen::Assemblies::Component * contextComponent 
            );
            public: NXOpen::ErrorList * CheckinComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & partOccs ,
                NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption checkinInputOption 
            );
            public: NXOpen::ErrorList * CheckoutComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & partOccs ,
                NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption checkoutInputOption 
            );
            public: NXOpen::ErrorList * CheckoutWorkset
            (
            );
            public: NXOpen::ErrorList * CheckinWorkset
            (
            );
            public: NXOpen::ErrorList * CheckoutAllModifiedObjects
            (
                std::vector<NXOpen::NXObject *> & checkedOutObjects 
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.2.  Use NXOpen::PDM::PdmSession::GetCheckedoutStatusOfAllObjectsInSession instead") void GetCheckedoutStatusOfObjects
            (
                std::vector<NXOpen::NXObject *> & checkedOutObjects ,
                std::vector<NXOpen::NXObject *> & uncheckedOutObjects 
            );
            public: void ReorderComponents
            (
                NXOpen::Assemblies::ComponentOrder * order ,
                const std::vector<NXOpen::Assemblies::Component *> & componentsToReorder ,
                NXOpen::Assemblies::Component * targetComponent ,
                NXOpen::Assemblies::ComponentAssembly::OrderTargetLocation beforeOrAfter 
            );
            public: void ReorderChildrenOfParent
            (
                NXOpen::Assemblies::ComponentOrder * order ,
                NXOpen::Assemblies::Component * parentComponent ,
                const std::vector<NXOpen::Assemblies::Component *> & componentsToReorder 
            );
            public: void GetComponentOrders
            (
                std::vector<NXOpen::Assemblies::ComponentOrder *> & orders 
            );
            public: void MoveToPendingComponent
            (
                NXOpen::NXObject * component 
            );
            public: NXOpen::Assemblies::Order * GetActiveOrder
            (
            );
            public: NXOpen::ErrorList * CreateIsolateViewWithComponents
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                NXOpen::View ** view 
            );
            public: NXOpen::ErrorList * ShowComponentsInIsolateView
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                NXOpen::View ** view 
            );
            public: NXOpen::ErrorList * HideComponentsInIsolateView
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                NXOpen::View ** view 
            );
            public: NXOpen::ErrorList * CheckoutDesignSession
            (
            );
            public: NXOpen::ErrorList * CheckinDesignSession
            (
            );
            public: NXOpen::ErrorList * CheckoutWorksetWithChangeIdAndComments
            (
                const NXString & comment  ,
                const NXString & changeId 
            );
            NXOpen::ErrorList * CheckoutWorksetWithChangeIdAndComments
            (
                const char * comment  ,
                const char * changeId 
            );
            public: NXOpen::ErrorList * CheckoutAllModifiedObjectsWithChangeIdAndComments
            (
                const NXString & comment  ,
                const NXString & changeId  ,
                std::vector<NXOpen::NXObject *> & checkedOutObjects 
            );
            NXOpen::ErrorList * CheckoutAllModifiedObjectsWithChangeIdAndComments
            (
                const char * comment  ,
                const char * changeId  ,
                std::vector<NXOpen::NXObject *> & checkedOutObjects 
            );
            public: NXOpen::ErrorList * CheckoutComponentsWithChangeIdAndComments
            (
                const NXString & changeId  ,
                const NXString & comment  ,
                const std::vector<NXOpen::Assemblies::Component *> & partOccs ,
                NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption checkoutInputOption 
            );
            NXOpen::ErrorList * CheckoutComponentsWithChangeIdAndComments
            (
                const char * changeId  ,
                const char * comment  ,
                const std::vector<NXOpen::Assemblies::Component *> & partOccs ,
                NXOpen::Assemblies::ComponentAssembly::CheckinCheckoutOption checkoutInputOption 
            );
            public: NXOpen::ErrorList * CheckoutDesignSessionWithChangeIdAndComments
            (
                const NXString & changeId  ,
                const NXString & comment 
            );
            NXOpen::ErrorList * CheckoutDesignSessionWithChangeIdAndComments
            (
                const char * changeId  ,
                const char * comment 
            );
            public: void DesignWorksetProductForceRecipeReplay
            (
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: NXOpen::Assemblies::ArrangementCollection *Arrangements();
            public: NXOpen::Assemblies::ExplosionCollection *Explosions();
            public: NXOpen::Assemblies::DrawingExplosionCollection *DrawingExplosions();
            public: NXOpen::Assemblies::ComponentPatternCollection *ComponentPatterns();
            public: NXOpen::Assemblies::SubsetCollection *Subsets();
            public: NXOpen::Assemblies::ClearanceSetCollection *ClearanceSets();
            public: NXOpen::Assemblies::OrderCollection *OrdersSet();
        };
    }
}
#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