CAM_Path.hxx

//--------------------------------------------------------------------------
// 版权所有 2024 Siemens
//--------------------------------------------------------------------------
//  JA API 的 C++ 接口头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     CAM_Path.ja
//
//  生成方式:
//     apiwrap
//
//  警告:
//     此文件为自动生成，请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/CAM_PathData.hxx>
#include <NXOpen/CAM_PathEvent.hxx>
#include <NXOpen/CAM_PathLaserOptimizationData.hxx>
#include <NXOpen/CAM_PathMarker.hxx>
#include <NXOpen/CAM_PathOwnerData.hxx>
#include <NXOpen/CAM_Ude.hxx>
#include <NXOpen/TaggedObject.hxx>
#include <NXOpen/libnxopencpp_cam_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 CAM
    {
        class Path;
    }
    namespace CAM
    {
        class PathCircularMotion;
    }
    namespace CAM
    {
        class PathEvent;
    }
    namespace CAM
    {
        class PathHelixMotion;
    }
    namespace CAM
    {
        class PathLaserOptimizationData;
    }
    namespace CAM
    {
        class PathLevelMarker;
    }
    namespace CAM
    {
        class PathLinearMotion;
    }
    namespace CAM
    {
        class PathMarker;
    }
    namespace CAM
    {
        class PathOwnerData;
    }
    namespace CAM
    {
        class Ude;
    }
    namespace CAM
    {
        class _PathBuilder;
        class PathImpl;
        class NXOPENCPP_CAMEXPORT  Path : public NXOpen::TaggedObject
        {
            public: enum FindingTypes
            {
                FindingTypesGouge = 1,
                FindingTypesSpike,
                FindingTypesSingularity = 5,
                FindingTypesSoftLimit,
                FindingTypesHardLimit,
                FindingTypesUnwind,
                FindingTypesCollision,
                FindingTypesReachFailure,
                FindingTypesVariableLimit,
                FindingTypesHolderCollision,
                FindingTypesRapidCollision,
                FindingTypesOverEngagement = 22
            };

            public: enum RobotRulesStatusStates
            {
                RobotRulesStatusStatesUnchanged ,
                RobotRulesStatusStatesChanged ,
                RobotRulesStatusStatesRegenerate ,
                RobotRulesStatusStatesRegenerated
            };
            private: PathImpl * m_path_impl;
            private: friend class  _PathBuilder;
            protected: Path();
public: ~Path();
            public: NXOpen::CAM::PathLinearMotion * NewPathLinearMotion
            (
            );
            public: NXOpen::CAM::PathCircularMotion * NewPathCircularMotion
            (
            );
            public: NXOpen::CAM::PathHelixMotion * NewPathHelixMotion
            (
            );
            public: NXOpen::CAM::CamPathToolAxisType ToolAxisType
            (
            );
            public: int NumberOfToolpathEvents
            (
            );
            public: NXOpen::CAM::PathEvent * GetToolpathEvent
            (
                int eventNumber 
            );
            public: NXOpen::CAM::CamPathToolpathEventType GetToolpathEventType
            (
                int eventNumber 
            );
            public: NXOpen::CAM::CamPathToolpathEventType GetToolpathEventType
            (
                NXOpen::CAM::PathEvent * pathEvent 
            );
            public: void MoveEvent
            (
                int fromIndex  ,
                int toIndex 
            );
            public: void MoveEvent
            (
                NXOpen::CAM::PathEvent * eventToMove  ,
                NXOpen::CAM::CamPathToolpathEventLocation location  ,
                NXOpen::CAM::PathEvent * referenceEvent 
            );
            public: bool IsToolpathEventAMotion
            (
                int eventNumber  ,
                NXOpen::CAM::CamPathMotionType* motionType  ,
                NXOpen::CAM::CamPathMotionShapeType* motionShape 
            );
            public: bool IsToolpathEventAMotion
            (
                NXOpen::CAM::PathEvent * eventOfInterest  ,
                NXOpen::CAM::CamPathMotionType* motionType  ,
                NXOpen::CAM::CamPathMotionShapeType* motionShape 
            );
            public: bool IsToolpathEventUde
            (
                NXOpen::CAM::PathEvent * eventOfInterest  ,
                NXString* udeName 
            );
            public: NXOpen::CAM::PathLinearMotion * GetLinearMotion
            (
                int index 
            );
            public: void SetLinearMotion
            (
                int index  ,
                NXOpen::CAM::PathLinearMotion * data 
            );
            public: void AppendLinearMotion
            (
                NXOpen::CAM::PathLinearMotion * data 
            );
            public: void InsertLinearMotionBefore
            (
                NXOpen::CAM::PathLinearMotion * data  ,
                int index 
            );
            public: void InsertLinearMotionAfter
            (
                NXOpen::CAM::PathLinearMotion * data  ,
                int index 
            );
            public: NXOpen::CAM::PathLinearMotion * GetLinearMotion
            (
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: NX_DEPRECATED("Deprecated in NX1872.0.0.  Use NXOpen::CAM::Path::ModifyLinearMotion instead.") void SetLinearMotion
            (
                NXOpen::CAM::PathEvent * eventOfInterest  ,
                NXOpen::CAM::PathLinearMotion * data 
            );
            public: NXOpen::CAM::PathEvent * AddLinearMotion
            (
                NXOpen::CAM::PathLinearMotion * data  ,
                NXOpen::CAM::CamPathToolpathEventLocation location  ,
                NXOpen::CAM::PathEvent * referenceEvent 
            );
            public: NXOpen::CAM::PathCircularMotion * GetCircularMotion
            (
                int index 
            );
            public: void SetCircularMotion
            (
                int index  ,
                NXOpen::CAM::PathCircularMotion * data 
            );
            public: void AppendCircularMotion
            (
                NXOpen::CAM::PathCircularMotion * data 
            );
            public: void InsertCircularMotionBefore
            (
                NXOpen::CAM::PathCircularMotion * data  ,
                int index 
            );
            public: void InsertCircularMotionAfter
            (
                NXOpen::CAM::PathCircularMotion * data  ,
                int index 
            );
            public: NXOpen::CAM::PathCircularMotion * GetCircularMotion
            (
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: NX_DEPRECATED("Deprecated in NX1872.0.0.  Use NXOpen::CAM::Path::ModifyCircularMotion instead.") void SetCircularMotion
            (
                NXOpen::CAM::PathEvent * eventOfInterest  ,
                NXOpen::CAM::PathCircularMotion * data 
            );
            public: NXOpen::CAM::PathEvent * AddCircularMotion
            (
                NXOpen::CAM::PathCircularMotion * data  ,
                NXOpen::CAM::CamPathToolpathEventLocation location  ,
                NXOpen::CAM::PathEvent * referenceEvent 
            );
            public: NXOpen::CAM::PathHelixMotion * GetHelixMotion
            (
                int index 
            );
            public: void SetHelixMotion
            (
                int index  ,
                NXOpen::CAM::PathHelixMotion * data 
            );
            public: void AppendHelixMotion
            (
                NXOpen::CAM::PathHelixMotion * data 
            );
            public: void InsertHelixMotionBefore
            (
                NXOpen::CAM::PathHelixMotion * data  ,
                int index 
            );
            public: void InsertHelixMotionAfter
            (
                NXOpen::CAM::PathHelixMotion * data  ,
                int index 
            );
            public: NXOpen::CAM::PathHelixMotion * GetHelixMotion
            (
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: NX_DEPRECATED("Deprecated in NX1872.0.0.  Use NXOpen::CAM::Path::ModifyHelixMotion instead.") void SetHelixMotion
            (
                NXOpen::CAM::PathEvent * eventOfInterest  ,
                NXOpen::CAM::PathHelixMotion * data 
            );
            public: NXOpen::CAM::PathEvent * AddHelixMotion
            (
                NXOpen::CAM::PathHelixMotion * data  ,
                NXOpen::CAM::CamPathToolpathEventLocation location  ,
                NXOpen::CAM::PathEvent * referenceEvent 
            );
            public: NXOpen::CAM::Ude * GetUde
            (
                int index 
            );
            public: void SetUde
            (
                int index  ,
                NXOpen::CAM::Ude * data 
            );
            public: void AppendUde
            (
                const NXString & udeName 
            );
            void AppendUde
            (
                const char * udeName 
            );
            public: void InsertUdeBefore
            (
                const NXString & udeName  ,
                int index 
            );
            void InsertUdeBefore
            (
                const char * udeName  ,
                int index 
            );
            public: void InsertUdeAfter
            (
                const NXString & udeName  ,
                int index 
            );
            void InsertUdeAfter
            (
                const char * udeName  ,
                int index 
            );
            public: NXOpen::CAM::Ude * GetUde
            (
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: void SetUde
            (
                NXOpen::CAM::PathEvent * eventOfInterest  ,
                NXOpen::CAM::Ude * data 
            );
            public: NXOpen::CAM::PathEvent * AddUde
            (
                const NXString & udeName  ,
                NXOpen::CAM::CamPathToolpathEventLocation location  ,
                NXOpen::CAM::PathEvent * referenceEvent 
            );
            NXOpen::CAM::PathEvent * AddUde
            (
                const char * udeName  ,
                NXOpen::CAM::CamPathToolpathEventLocation location  ,
                NXOpen::CAM::PathEvent * referenceEvent 
            );
            public: void EmptyPath
            (
            );
            public: void DeleteOneEvent
            (
                int index 
            );
            public: void DeleteOneEvent
            (
                NXOpen::CAM::PathEvent * pathEvent 
            );
            public: NXOpen::CAM::PathLaserOptimizationData * GetLaserOptimizationData
            (
            );
            public: NXOpen::CAM::PathLevelMarker * GetLevelMarker
            (
                int index 
            );
            public: void SetLevelMarker
            (
                int index ,
                NXOpen::CAM::PathLevelMarker * data 
            );
            public: void AppendLevelMarker
            (
                NXOpen::CAM::PathLevelMarker * data 
            );
            public: void InsertLevelMarkerBefore
            (
                NXOpen::CAM::PathLevelMarker * data ,
                int index 
            );
            public: void InsertLevelMarkerAfter
            (
                NXOpen::CAM::PathLevelMarker * data ,
                int index 
            );
            public: NXOpen::CAM::PathLevelMarker * GetLevelMarker
            (
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: void SetLevelMarker
            (
                NXOpen::CAM::PathEvent * eventOfInterest ,
                NXOpen::CAM::PathLevelMarker * data 
            );
            public: NXOpen::CAM::PathEvent * AddLevelMarker
            (
                NXOpen::CAM::PathLevelMarker * data ,
                NXOpen::CAM::CamPathToolpathEventLocation location ,
                NXOpen::CAM::PathEvent * referenceEvent 
            );
            public: NXOpen::CAM::PathEvent * GetFirstEvent
            (
            );
            public: NXOpen::CAM::PathEvent * GetLastEvent
            (
            );
            public: void DeleteAllUdesOfName
            (
                const NXString & udeName 
            );
            void DeleteAllUdesOfName
            (
                const char * udeName 
            );
            public: NXOpen::CAM::CamPathContactType ContactType
            (
            );
            public: void SetContactType
            (
                NXOpen::CAM::CamPathContactType contactType 
            );
            public: NXOpen::CAM::PathMarker * NewPathMarker
            (
                NXOpen::CAM::PathMarker::Type markerType 
            );
            public: NXOpen::CAM::PathMarker * GetMarker
            (
                int index 
            );
            public: void SetMarker
            (
                int index ,
                NXOpen::CAM::PathMarker * data 
            );
            public: void AppendMarker
            (
                NXOpen::CAM::PathMarker * data 
            );
            public: void InsertMarkerBefore
            (
                NXOpen::CAM::PathMarker * data ,
                int index 
            );
            public: void InsertMarkerAfter
            (
                NXOpen::CAM::PathMarker * data ,
                int index 
            );
            public: NXOpen::CAM::PathMarker * GetMarker
            (
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: void SetMarker
            (
                NXOpen::CAM::PathEvent * eventOfInterest ,
                NXOpen::CAM::PathMarker * data 
            );
            public: NXOpen::CAM::PathEvent * AddMarker
            (
                NXOpen::CAM::PathMarker * data ,
                NXOpen::CAM::CamPathToolpathEventLocation location ,
                NXOpen::CAM::PathEvent * referenceEvent 
            );
            public: int GetNumberOfFindings
            (
                NXOpen::CAM::Path::FindingTypes type 
            );
            public: void GetAllFindingTypes
            (
                std::vector<NXOpen::CAM::Path::FindingTypes> & findingTypes 
            );
            public: void GetFindingStartEndEvents
            (
                NXOpen::CAM::Path::FindingTypes type ,
                std::vector<NXOpen::CAM::PathEvent *> & startEvents ,
                std::vector<NXOpen::CAM::PathEvent *> & endEvents 
            );
            public: NXOpen::CAM::Path::RobotRulesStatusStates RobotRulesStatus
            (
            );
            public: void SetRobotRulesStatus
            (
                NXOpen::CAM::Path::RobotRulesStatusStates status 
            );
            public: NXOpen::CAM::PathEvent * ModifyLinearMotion
            (
                NXOpen::CAM::PathLinearMotion * data  ,
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: NXOpen::CAM::PathEvent * ModifyCircularMotion
            (
                NXOpen::CAM::PathCircularMotion * data  ,
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: NXOpen::CAM::PathEvent * ModifyHelixMotion
            (
                NXOpen::CAM::PathHelixMotion * data  ,
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: bool IsFirstEvent
            (
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: bool IsLastEvent
            (
                NXOpen::CAM::PathEvent * eventOfInterest 
            );
            public: void GetWidthHeight
            (
                NXOpen::CAM::PathEvent * eventOfInterest  ,
                double* width  ,
                double* height 
            );
            public: void SetWidthHeight
            (
                NXOpen::CAM::PathEvent * eventOfInterest  ,
                double width  ,
                double height 
            );
            public: NXOpen::CAM::PathEvent * CopyEvent
            (
                NXOpen::CAM::PathEvent * eventToCopy  ,
                NXOpen::CAM::CamPathToolpathEventLocation location  ,
                NXOpen::CAM::PathEvent * referenceEvent 
            );
            public: NXOpen::CAM::PathOwnerData * GetReferenceData
            (
            );
            public: bool HasSubPath
            (
            );
            public: NXOpen::CAM::PathOwnerData * GetSubPathData
            (
                NXOpen::CAM::PathEvent * forEvent 
            );
};
    }
}
#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