Assemblies_Component.hxx

//--------------------------------------------------------------------------
// 版权所有 2024 Siemens
//--------------------------------------------------------------------------
//  JA API 的 C++ 接口头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     Assemblies_Component.ja
//
//  生成方式:
//     apiwrap
//
//  警告:
//     此文件为自动生成，请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/Assemblies_IsPartitionableResult.hxx>
#include <NXOpen/Assemblies_Partition.hxx>
#include <NXOpen/Assemblies_PartitionSchemeInstance.hxx>
#include <NXOpen/Assemblies_Subset.hxx>
#include <NXOpen/ErrorList.hxx>
#include <NXOpen/NXObject.hxx>
#include <NXOpen/DisplayableObject.hxx>
#include <NXOpen/INXObject.hxx>
#include <NXOpen/Routing_ICharacteristic.hxx>
#include <NXOpen/PartFamily_InstanceSelectionCriteria.hxx>
#include <NXOpen/PartFamily_Template.hxx>
#include <NXOpen/Routing_CharacteristicList.hxx>
#include <NXOpen/Update.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 Component;
    }
    namespace Assemblies
    {
        class Arrangement;
    }
    namespace Assemblies
    {
        class ComponentAssembly;
    }
    namespace Assemblies
    {
        class ComponentPattern;
    }
    namespace Assemblies
    {
        class IsPartitionableResult;
    }
    namespace Assemblies
    {
        class Partition;
    }
    namespace Assemblies
    {
        class PartitionSchemeInstance;
    }
    namespace Assemblies
    {
        class Subset;
    }
    class BasePart;
    class DisplayableObject;
    class ErrorList;
    class Expression;
    class INXObject;
    class NXObject;
    namespace PDM
    {
        class DesignElementRevision;
    }
    namespace PDM
    {
        class DesignSubordinateRevision;
    }
    namespace PDM
    {
        class ModelElementRevision;
    }
    class Part;
    namespace PartFamily
    {
        class InstanceSelectionCriteria;
    }
namespace PartFamily
{
    class Template;
}
namespace Positioning
{
    class ComponentConstraint;
}
namespace Routing
{
    class CharacteristicList;
}
namespace Routing
{
    class ICharacteristic;
}
class Unit;
namespace Assemblies
{
    enum ComponentQuantity
    {
        ComponentQuantityNone,
        ComponentQuantityInteger,
        ComponentQuantityReal,
        ComponentQuantityAsRequired
    };

    enum DegreesOfFreedomResult
    {
        DegreesOfFreedomResultUnknown,
        DegreesOfFreedomResultSuccess
    };

    enum DegreesOfFreedomStatus
    {
        DegreesOfFreedomStatusNotUsed,
        DegreesOfFreedomStatusStatic,
        DegreesOfFreedomStatusFree,
        DegreesOfFreedomStatusInstantaneous,
        DegreesOfFreedomStatusStaticNormal,
        DegreesOfFreedomStatusFreeNormal,
        DegreesOfFreedomStatusInstantaneousNormal
    };

    struct DegreesOfFreedom
    {
        public: NXOpen::Assemblies::DegreesOfFreedomResult Result;
        public: int NumRotational;
        public: int NumTranslational;
        public: int NumInstantaneousRotational;
        public: int NumInstantaneousTranslational;
        public: NXOpen::Assemblies::DegreesOfFreedomStatus BasePoint1Status;
        public: NXOpen::Point3d BasePoint1;
        public: NXOpen::Assemblies::DegreesOfFreedomStatus RotationDirection1Status;
        public: NXOpen::Vector3d RotationDirection1;
        public: NXOpen::Assemblies::DegreesOfFreedomStatus BasePoint2Status;
        public: NXOpen::Point3d BasePoint2;
        public: NXOpen::Assemblies::DegreesOfFreedomStatus RotationDirection2Status;
        public: NXOpen::Vector3d RotationDirection2;
        public: NXOpen::Assemblies::DegreesOfFreedomStatus TranslationDirection1Status;
        public: NXOpen::Vector3d TranslationDirection1;
        public: NXOpen::Assemblies::DegreesOfFreedomStatus TranslationDirection2Status;
        public: NXOpen::Vector3d TranslationDirection2;
        public: DegreesOfFreedom() :
            Result((NXOpen::Assemblies::DegreesOfFreedomResult)0),
            NumRotational(),
            NumTranslational(),
            NumInstantaneousRotational(),
            NumInstantaneousTranslational(),
            BasePoint1Status((NXOpen::Assemblies::DegreesOfFreedomStatus)0),
            BasePoint1(),
            RotationDirection1Status((NXOpen::Assemblies::DegreesOfFreedomStatus)0),
            RotationDirection1(),
            BasePoint2Status((NXOpen::Assemblies::DegreesOfFreedomStatus)0),
            BasePoint2(),
            RotationDirection2Status((NXOpen::Assemblies::DegreesOfFreedomStatus)0),
            RotationDirection2(),
            TranslationDirection1Status((NXOpen::Assemblies::DegreesOfFreedomStatus)0),
            TranslationDirection1(),
            TranslationDirection2Status((NXOpen::Assemblies::DegreesOfFreedomStatus)0),
            TranslationDirection2()
        {
        }
            public: DegreesOfFreedom(NXOpen::Assemblies::DegreesOfFreedomResult resultInitial ,
                    int numRotationalInitial ,
                    int numTranslationalInitial ,
                    int numInstantaneousRotationalInitial ,
                    int numInstantaneousTranslationalInitial ,
                    NXOpen::Assemblies::DegreesOfFreedomStatus basePoint1StatusInitial ,
                    const NXOpen::Point3d &basePoint1Initial ,
                    NXOpen::Assemblies::DegreesOfFreedomStatus rotationDirection1StatusInitial ,
                    const NXOpen::Vector3d &rotationDirection1Initial ,
                    NXOpen::Assemblies::DegreesOfFreedomStatus basePoint2StatusInitial ,
                    const NXOpen::Point3d &basePoint2Initial ,
                    NXOpen::Assemblies::DegreesOfFreedomStatus rotationDirection2StatusInitial ,
                    const NXOpen::Vector3d &rotationDirection2Initial ,
                    NXOpen::Assemblies::DegreesOfFreedomStatus translationDirection1StatusInitial ,
                    const NXOpen::Vector3d &translationDirection1Initial ,
                    NXOpen::Assemblies::DegreesOfFreedomStatus translationDirection2StatusInitial ,
                    const NXOpen::Vector3d &translationDirection2Initial ) :
                Result(resultInitial),
                NumRotational(numRotationalInitial),
                NumTranslational(numTranslationalInitial),
                NumInstantaneousRotational(numInstantaneousRotationalInitial),
                NumInstantaneousTranslational(numInstantaneousTranslationalInitial),
                BasePoint1Status(basePoint1StatusInitial),
                BasePoint1(basePoint1Initial),
                RotationDirection1Status(rotationDirection1StatusInitial),
                RotationDirection1(rotationDirection1Initial),
                BasePoint2Status(basePoint2StatusInitial),
                BasePoint2(basePoint2Initial),
                RotationDirection2Status(rotationDirection2StatusInitial),
                RotationDirection2(rotationDirection2Initial),
                TranslationDirection1Status(translationDirection1StatusInitial),
                TranslationDirection1(translationDirection1Initial),
                TranslationDirection2Status(translationDirection2StatusInitial),
                TranslationDirection2(translationDirection2Initial)
            {
            }
        };

        enum PositionOverrideType
        {
            PositionOverrideTypeNone,
            PositionOverrideTypeUnloaded,
            PositionOverrideTypeExplicit,
            PositionOverrideTypeMatingImplicit,
            PositionOverrideTypeConstraintImplicit
        };

        enum CollaborativeContentType
        {
            CollaborativeContentTypeWorkset,
            CollaborativeContentTypeSubset,
            CollaborativeContentTypeShapeDesignElement,
            CollaborativeContentTypeReuseDesignElement,
            CollaborativeContentTypePromissoryDesignElement,
            CollaborativeContentTypeSubordinate,
            CollaborativeContentTypeDesignFeature,
            CollaborativeContentTypeDesignControlElement,
            CollaborativeContentTypeNotAssigned
        };
    }
    namespace Assemblies
    {
        class _ComponentBuilder;
        class ComponentImpl;
        class NXOPENCPP_ASSEMBLIESEXPORT  Component : public NXOpen::DisplayableObject, public virtual NXOpen::Routing::ICharacteristic
        {
            public: enum RepresentationMode
            {
                RepresentationModeLightweight,
                RepresentationModePartial,
                RepresentationModeExact,
                RepresentationModeNone
            };
            private: ComponentImpl * m_component_impl;
            private: friend class  _ComponentBuilder;
            protected: Component();
public: ~Component();
            public: NXOpen::Assemblies::Component * Parent
            (
            );
            public: NXOpen::Assemblies::ComponentAssembly * DirectOwner
            (
            );
            public: std::vector<NXOpen::Assemblies::Component *> GetChildren
            (
            );
            public: NXOpen::NXObject * FindOccurrence
            (
                NXOpen::NXObject * proto 
            );
            public: int GetLayerOption
            (
            );
            public: void SetLayerOption
            (
                int layer 
            );
            public: NXString EntirePartRefsetName
            (
            );
            public: NXString EmptyPartRefsetName
            (
            );
            public: NXString ReferenceSet
            (
            );
            public: void GetPosition
            (
                NXOpen::Point3d* position ,
                NXOpen::Matrix3x3* orientation 
            );
            public: void EstablishPositionOverride
            (
                NXOpen::Assemblies::Component * parent 
            );
            public: void EstablishIsolatedPositionOverride
            (
                NXOpen::Assemblies::Component * parent ,
                NXOpen::Assemblies::Arrangement * arrangement 
            );
            public: void SetPositioningIsolated
            (
                NXOpen::Assemblies::Arrangement * arrangement 
            );
            public: bool IsPositioningIsolated
            (
                NXOpen::Assemblies::Arrangement * arrangement 
            );
            public: void RemovePositionOverride
            (
                NXOpen::Assemblies::Component * parent 
            );
            public: NXOpen::Assemblies::Component * GetPositionOverrideParent
            (
            );
            public: NXOpen::Assemblies::PositionOverrideType GetPositionOverrideType
            (
            );
            public: void GetArrangements
            (
                std::vector<NXOpen::Assemblies::Arrangement *> & arrangements 
            );
            public: NXOpen::Assemblies::Arrangement * SuppressingArrangement
            (
            );
            public: void SetUsedArrangement
            (
                NXOpen::Assemblies::Arrangement * newArrangement 
            );
            public: NXOpen::Assemblies::Arrangement * UsedArrangement
            (
            );
            public: void SetPositioningVaried
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                bool setAsVaried 
            );
            public: bool IsSuppressed
            (
            );
            public: void Suppress
            (
            );
            public: NXOpen::ErrorList * Suppress
            (
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: void Unsuppress
            (
            );
            public: NXOpen::ErrorList * Unsuppress
            (
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: void UpdateStructure
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                int nLevels 
            );
            public: void UpdateStructure
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                int nLevels ,
                bool checkComponentsVisited 
            );
            public: NXString DisplayName
            (
            );
            public: bool IsFixed
            (
            );
            public: NXOpen::Positioning::ComponentConstraint * FixConstraint
            (
            );
            public: std::vector<NXOpen::Positioning::ComponentConstraint *> GetConstraints
            (
            );
            public: NXOpen::Assemblies::DegreesOfFreedom GetDegreesOfFreedom
            (
            );
            public: NXOpen::Assemblies::DegreesOfFreedom GetDegreesOfFreedom
            (
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: void RecallConstraints
            (
            );
            public: std::vector<NXOpen::Positioning::ComponentConstraint *> RecallAndListConstraints
            (
            );
            public: void RemoveRememberedConstraints
            (
            );
            public: bool GetNonGeometricState
            (
            );
            public: NXOpen::Assemblies::ComponentQuantity GetComponentQuantityType
            (
            );
            public: int GetIntegerQuantity
            (
            );
            public: double GetRealQuantity
            (
                NXString* quantityUnits 
            );
            public: NXString GetAsRequiredQuantity
            (
            );
            public: NXOpen::ErrorList * DisplayComponentsLightweight
            (
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: NXOpen::ErrorList * DisplayComponentsExact
            (
                const std::vector<NXOpen::Assemblies::Component *> & components 
            );
            public: NXOpen::Assemblies::Component::RepresentationMode GetComponentRepresentationMode
            (
            );
            public: void SetInstanceUserAttribute
            (
                const NXOpen::NXObject::AttributeInformation & info  ,
                NXOpen::Update::Option option 
            );
            public: void SetInstanceUserAttribute
            (
                const NXString & title  ,
                int index  ,
                int value  ,
                NXOpen::Update::Option option 
            );
            void SetInstanceUserAttribute
            (
                const char * title  ,
                int index  ,
                int value  ,
                NXOpen::Update::Option option 
            );
            public: void SetInstanceUserAttribute
            (
                const NXString & title  ,
                int index  ,
                double value  ,
                NXOpen::Update::Option option 
            );
            void SetInstanceUserAttribute
            (
                const char * title  ,
                int index  ,
                double value  ,
                NXOpen::Update::Option option 
            );
            public: void SetInstanceUserAttribute
            (
                const NXString & title  ,
                int index  ,
                const NXString & value  ,
                NXOpen::Update::Option option 
            );
            void SetInstanceUserAttribute
            (
                const char * title  ,
                int index  ,
                const char * value  ,
                NXOpen::Update::Option option 
            );
            public: void SetInstanceUserAttribute
            (
                const NXString & title  ,
                int index  ,
                NXOpen::Update::Option option 
            );
            void SetInstanceUserAttribute
            (
                const char * title  ,
                int index  ,
                NXOpen::Update::Option option 
            );
            public: void SetInstanceTimeUserAttribute
            (
                const NXString & title  ,
                int index  ,
                const NXString & value ,
                NXOpen::Update::Option option 
            );
            void SetInstanceTimeUserAttribute
            (
                const char * title  ,
                int index  ,
                const char * value ,
                NXOpen::Update::Option option 
            );
            public: void SetInstanceBooleanUserAttribute
            (
                const NXString & title  ,
                int index  ,
                bool value  ,
                NXOpen::Update::Option option 
            );
            void SetInstanceBooleanUserAttribute
            (
                const char * title  ,
                int index  ,
                bool value  ,
                NXOpen::Update::Option option 
            );
            public: bool HasInstanceUserAttribute
            (
                const NXString & title  ,
                NXOpen::NXObject::AttributeType type  ,
                int index 
            );
            bool HasInstanceUserAttribute
            (
                const char * title  ,
                NXOpen::NXObject::AttributeType type  ,
                int index 
            );
            public: NXOpen::NXObject::AttributeInformation GetInstanceUserAttribute
            (
                const NXString & title  ,
                NXOpen::NXObject::AttributeType type  ,
                int index 
            );
            NXOpen::NXObject::AttributeInformation GetInstanceUserAttribute
            (
                const char * title  ,
                NXOpen::NXObject::AttributeType type  ,
                int index 
            );
            public: bool GetInstanceBooleanUserAttribute
            (
                const NXString & title  ,
                int index 
            );
            bool GetInstanceBooleanUserAttribute
            (
                const char * title  ,
                int index 
            );
            public: int GetInstanceIntegerUserAttribute
            (
                const NXString & title  ,
                int index 
            );
            int GetInstanceIntegerUserAttribute
            (
                const char * title  ,
                int index 
            );
            public: double GetInstanceRealUserAttribute
            (
                const NXString & title  ,
                int index 
            );
            double GetInstanceRealUserAttribute
            (
                const char * title  ,
                int index 
            );
            public: NXString GetInstanceStringUserAttribute
            (
                const NXString & title  ,
                int index 
            );
            NXString GetInstanceStringUserAttribute
            (
                const char * title  ,
                int index 
            );
            public: NXString GetInstanceTimeUserAttribute
            (
                const NXString & title  ,
                int index 
            );
            NXString GetInstanceTimeUserAttribute
            (
                const char * title  ,
                int index 
            );
            public: std::vector<NXOpen::NXObject::AttributeInformation> GetInstanceUserAttributes
            (
            );
            public: std::vector<NXOpen::NXObject::AttributeInformation> GetInstanceUserAttributes
            (
                bool includeUnset 
            );
            public: NXString GetInstanceUserAttributeAsString
            (
                const NXString & title  ,
                NXOpen::NXObject::AttributeType type  ,
                int index 
            );
            NXString GetInstanceUserAttributeAsString
            (
                const char * title  ,
                NXOpen::NXObject::AttributeType type  ,
                int index 
            );
            public: std::vector<NXString> GetInstanceUserAttributesAsStrings
            (
            );
            public: void DeleteInstanceUserAttribute
            (
                NXOpen::NXObject::AttributeType type  ,
                const NXString & title  ,
                bool deleteEntireArray  ,
                NXOpen::Update::Option option 
            );
            void DeleteInstanceUserAttribute
            (
                NXOpen::NXObject::AttributeType type  ,
                const char * title  ,
                bool deleteEntireArray  ,
                NXOpen::Update::Option option 
            );
            public: void DeleteInstanceUserAttributes
            (
                NXOpen::NXObject::AttributeType type  ,
                NXOpen::Update::Option option 
            );
            public: void SetInstanceUserAttributeLock
            (
                const NXString & title  ,
                NXOpen::NXObject::AttributeType type  ,
                bool lock 
            );
            void SetInstanceUserAttributeLock
            (
                const char * title  ,
                NXOpen::NXObject::AttributeType type  ,
                bool lock 
            );
            public: bool GetInstanceUserAttributeLock
            (
                const NXString & title  ,
                NXOpen::NXObject::AttributeType type 
            );
            bool GetInstanceUserAttributeLock
            (
                const char * title  ,
                NXOpen::NXObject::AttributeType type 
            );
            public: NXOpen::Assemblies::Subset * Subset
            (
            );
            public: NXOpen::Assemblies::CollaborativeContentType CollaborativeContentType
            (
            );
            public: NX_DEPRECATED("在 NX11.0.0 中弃用。请改用 NXOpen::Assemblies::Component::ModelElementRevision。") NXOpen::PDM::DesignElementRevision * DesignElementRevision
            (
            );
            public: NXOpen::PDM::DesignSubordinateRevision * DesignSubordinateRevision
            (
            );
            public: NXOpen::PartFamily::InstanceSelectionCriteria * CreateEmptyPartFamilyInstanceSelectionCriteria
            (
                NXOpen::PartFamily::Template * family 
            );
            public: NXOpen::PartFamily::InstanceSelectionCriteria * GetPartFamilyInstanceSelectionCriteria
            (
            );
            public: void SetPartFamilyInstanceSelectionCriteria
            (
                NXOpen::PartFamily::InstanceSelectionCriteria * selectionCriteria 
            );
            public: void DeletePartFamilyInstanceSelectionCriteria
            (
            );
            public: void FindComponentPatterns
            (
                NXOpen::Assemblies::ComponentPattern ** patternDefinition ,
                std::vector<NXOpen::Assemblies::ComponentPattern *> & patternDefinitions 
            );
            public: NXOpen::PDM::ModelElementRevision * ModelElementRevision
            (
            );
            public: NXOpen::Assemblies::PartitionSchemeInstance * PartitionSchemeInstance
            (
            );

            public: void SetUserNameOfConfiguration
            (
                const NXString & userName 
            );
            void SetUserNameOfConfiguration
            (
                const char * userName 
            );

            public: NXString GetUserNameOfConfiguration
            (
            );

            public: void EvaluatePartFamilyInstanceSelectionCriteria
            (
                bool* componentChanged ,
                NXOpen::Part ** newPartFamilyMember ,
                NXString* errorinfo 
            );
            public: void AddToPartitions
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                const std::vector<NXOpen::Assemblies::Partition *> & partitions 
            );
            public: void RemoveFromPartitions
            (
                const std::vector<NXOpen::Assemblies::Component *> & components ,
                const std::vector<NXOpen::Assemblies::Partition *> & partitions 
            );

            public: void MakePrimaryConfiguration
            (
            );

            public: std::vector<NXOpen::Assemblies::IsPartitionableResult *> IsPartitionable
            (
                const std::vector<NXOpen::Assemblies::Component *> & components  ,
                const std::vector<NXOpen::Assemblies::Partition *> & partitions 
            );
            public: virtual NXOpen::Routing::CharacteristicList * GetCharacteristics
            (
            );
            public: NX_DEPRECATED("Deprecated in NX11.0.0.  Use NXOpen::Routing::ICharacteristic::SetCharacteristics2 instead.") virtual void SetCharacteristics
            (
                NXOpen::Routing::CharacteristicList * values 
            );
            public: virtual int GetIntegerCharacteristic
            (
                const NXString & name 
            );
            virtual int GetIntegerCharacteristic
            (
                const char * name 
            );
            public: NX_DEPRECATED("Deprecated in NX11.0.0.  Use NXOpen::Routing::ICharacteristic::SetCharacteristic2 instead.") virtual void SetCharacteristic
            (
                const NXString & name  ,
                int value 
            );
            virtual void SetCharacteristic
            (
                const char * name  ,
                int value 
            );
            public: virtual double GetRealCharacteristic
            (
                const NXString & name 
            );
            virtual double GetRealCharacteristic
            (
                const char * name 
            );
            public: NX_DEPRECATED("Deprecated in NX11.0.0.  Use NXOpen::Routing::ICharacteristic::SetCharacteristic2 instead.") virtual void SetCharacteristic
            (
                const NXString & name  ,
                double value 
            );
            virtual void SetCharacteristic
            (
                const char * name  ,
                double value 
            );
            public: virtual NXString GetStringCharacteristic
            (
                const NXString & name 
            );
            virtual NXString GetStringCharacteristic
            (
                const char * name 
            );
            public: NX_DEPRECATED("Deprecated in NX11.0.0.  Use NXOpen::Routing::ICharacteristic::SetCharacteristic2 instead.") virtual void SetCharacteristic
            (
                const NXString & name  ,
                const NXString & value 
            );
            virtual void SetCharacteristic
            (
                const char * name  ,
                const char * value 
            );
            public: virtual void DeleteCharacterstics
            (
                NXOpen::Routing::CharacteristicList * values 
            );
            public: virtual NXOpen::Routing::CharacteristicList * GetDestinationCharacteristics
            (
            );
            public: virtual void SetCharacteristic2
            (
                const NXString & title ,
                int value 
            );
            virtual void SetCharacteristic2
            (
                const char * title ,
                int value 
            );
            public: virtual void SetCharacteristic2
            (
                const NXString & title ,
                double value 
            );
            virtual void SetCharacteristic2
            (
                const char * title ,
                double value 
            );
            public: virtual void SetCharacteristic2
            (
                const NXString & title ,
                const NXString & value 
            );
            virtual void SetCharacteristic2
            (
                const char * title ,
                const char * value 
            );
            public: virtual void SetCharacteristics2
            (
                NXOpen::Routing::CharacteristicList * values 
            );
        };
    }
}
#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