Routing_Port.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  用于JA API的C++接口头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     Routing_Port.ja
//
//  生成工具:
//     apiwrap
//
//  警告:
//    此文件为自动生成，请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/INXObject.hxx>
#include <NXOpen/Routing_ICharacteristic.hxx>
#include <NXOpen/Routing_IRoutePosition.hxx>
#include <NXOpen/SmartObject.hxx>
#include <NXOpen/Routing_CharacteristicList.hxx>
#include <NXOpen/ugmath.hxx>
#include <NXOpen/libnxopencpp_routing_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 Routing
    {
        class Port;
    }
    namespace Assemblies
    {
        class Component;
    }
    class BasePart;
    class DisplayableObject;
    class Expression;
    namespace Features
    {
        class WaveRouting;
    }
    class INXObject;
    class NXObject;
    class Point;
    namespace Positioning
    {
        class Constraint;
    }
    namespace Routing
    {
        class CharacteristicList;
    }
    namespace Routing
    {
        class ControlPoint;
    }
    namespace Routing
    {
        class FeaturePort;
    }
    namespace Routing
    {
        class ICharacteristic;
    }
    namespace Routing
    {
        class IRoutePosition;
    }
    namespace Routing
    {
        class ISegment;
    }
    namespace Routing
    {
        class PortConnection;
    }
    namespace Routing
    {
        class Stock;
    }
    class SmartObject;
    namespace Routing
    {
        class _PortBuilder;
        class PortImpl;
        class NXOPENCPP_ROUTINGEXPORT  Port : public NXOpen::SmartObject, public virtual NXOpen::Routing::IRoutePosition
        {
            public: enum PortType
            {
                PortTypeUnknownPort,
                PortTypeFittingPort,
                PortTypeFixturePort,
                PortTypeMultiPort,
                PortTypeTerminalPort,
                PortTypeStockPort,
                PortTypeStockOffsetPort
            };

            public: enum FlowDirectionType
            {
                FlowDirectionTypeRouteFlowEither ,
                FlowDirectionTypeRouteFlowIn ,
                FlowDirectionTypeRouteFlowOut ,
                FlowDirectionTypeFlowNone
            };

            public: enum CreateRotationVector
            {
                CreateRotationVectorNo,
                CreateRotationVectorYes
            };
            private: PortImpl * m_port_impl;
            private: friend class  _PortBuilder;
            protected: Port();
public: ~Port();
            public: NXOpen::Routing::Port::PortType GetPortType
            (
            );
            public: NXOpen::Vector3d GetAlignmentVector
            (
            );
            public: double GetClockIncrement
            (
            );
            public: void SetClockIncrement
            (
                double increment 
            );
            public: NXOpen::Routing::Port::FlowDirectionType GetFlowDirection
            (
            );
            public: void SetFlowDirection
            (
                NXOpen::Routing::Port::FlowDirectionType flowDirection 
            );
            public: NXOpen::Vector3d GetRotationVector
            (
            );
            public: NXOpen::DisplayableObject * GetRotationObject
            (
            );
            public: NXOpen::Routing::ISegment * GetSegment
            (
            );
            public: double GetForwardExtension
            (
            );
            public: NXOpen::Expression * GetForwardExtensionObject
            (
            );
            public: double BackwardExtension
            (
            );
            public: void SetBackwardExtension
            (
                double extension 
            );
            public: NXOpen::Expression * BackwardExtensionObject
            (
            );
            public: void SetBackwardExtensionObject
            (
                NXOpen::Expression * backwardExtension 
            );
            public: double GetEngagement
            (
            );
            public: NXOpen::Point3d GetEngagementPosition
            (
            );
            public: double GetCutbackLength
            (
            );
            public: int FindPortIntegerCharacteristic
            (
                const NXString & name 
            );
            int FindPortIntegerCharacteristic
            (
                const char * name 
            );
            public: double FindPortRealCharacteristic
            (
                const NXString & name 
            );
            double FindPortRealCharacteristic
            (
                const char * name 
            );
            public: NXString FindPortStringCharacteristic
            (
                const NXString & name 
            );
            NXString FindPortStringCharacteristic
            (
                const char * name 
            );
            public: bool AllowMultipleConnections
            (
            );
            public: void SetAllowMultipleConnections
            (
                bool allowMultipleConnections 
            );
            public: NXString GetReferenceCharacteristic
            (
                const NXString & name 
            );
            NXString GetReferenceCharacteristic
            (
                const char * name 
            );
            public: void SetReferenceCharacteristic
            (
                const NXString & name  ,
                const NXString & value 
            );
            void SetReferenceCharacteristic
            (
                const char * name  ,
                const char * value 
            );
            public: NXOpen::Routing::PortConnection * Connect
            (
            );
            public: void Disconnect
            (
            );
            public: std::vector<NXOpen::Positioning::Constraint *> LockEngagement
            (
                NXOpen::Routing::Port * portToLock 
            );
            public: std::vector<NXOpen::Positioning::Constraint *> LockRotation
            (
                NXOpen::Routing::Port * portToLock 
            );
            public: void UnlockEngagement
            (
                NXOpen::Routing::Port * portToUnlock 
            );
            public: void UnlockRotation
            (
                NXOpen::Routing::Port * portToUnlock 
            );
            public: bool IsRotationLocked
            (
                NXOpen::Routing::Port * portToCheck 
            );
            public: bool IsEngagementLocked
            (
                NXOpen::Routing::Port * portToCheck 
            );
            public: NXOpen::Expression * ClockIncrementObject
            (
            );
            public: void SetClockIncrementObject
            (
                NXOpen::Expression * increment 
            );
            public: NXOpen::Routing::FeaturePort * AskFeature
            (
            );
            public: NXOpen::Features::WaveRouting * AskWaveFeature
            (
            );
            public: void ReorderFeature
            (
            );
            public: NXOpen::Assemblies::Component * GetComponent
            (
            );
            public: void GetConnectedPorts
            (
                NXOpen::Routing::Port ** connectedPort1  ,
                NXOpen::Routing::Port ** connectedPort2 
            );
            public: NXOpen::Routing::PortConnection * GetPortConnection
            (
            );
            public: NXOpen::NXObject * GetOccurrence
            (
            );
            public: NXOpen::Routing::ControlPoint * GetControlPoint
            (
            );
            public: NXOpen::Routing::Stock * GetStockOfPort
            (
            );
            public: virtual NXOpen::Point3d Position
            (
            );
            public: virtual void SetPosition
            (
                const NXOpen::Point3d & position 
            );
            public: virtual NXOpen::Point * Point
            (
            );
            public: virtual void SetPoint
            (
                NXOpen::Point * point 
            );
            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