Routing_CustomManager.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  用于JA API的C++接口头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     Routing_CustomManager.ja
//
//  生成工具:
//     apiwrap
//
//  警告:
//    此文件为自动生成，请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/TaggedObject.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 CustomManager;
    }
    class Session;
    namespace Assemblies
    {
        class Component;
    }
    class Curve;
    class NXObject;
    namespace Routing
    {
        class ChoosePartPluginData;
    }
    namespace Routing
    {
        class ComponentNamePluginData;
    }
    namespace Routing
    {
        class DesignRuleViolation;
    }
    namespace Routing
    {
        namespace Electrical
        {
            class Connection;
        }
    }
    namespace Routing
    {
        namespace Electrical
        {
            class HarnessDevice;
        }
    }
    namespace Routing
    {
        namespace Electrical
        {
            class SortConnectionsPluginData;
        }
    }
    namespace Routing
    {
        class Overstock;
    }
    namespace Routing
    {
        class Stock;
    }
    namespace Routing
    {
        class StockData;
    }
    namespace Routing
    {
        class CustomManagerImpl;
        class NXOPENCPP_ROUTINGEXPORT  CustomManager
        {
            public: enum CallbackReason
            {
                CallbackReasonUnknown = -1,
                CallbackReasonPlacePart,
                CallbackReasonMovePart,
                CallbackReasonRemovePart,
                CallbackReasonMovePath,
                CallbackReasonCopyPath,
                CallbackReasonDeletePath,
                CallbackReasonTransformPath,
                CallbackReasonOffsetPath,
                CallbackReasonAssignStock,
                CallbackReasonWireRouteManual,
                CallbackReasonWireRouteAuto,
                CallbackReasonWireCompManual,
                CallbackReasonWireCompAuto,
                CallbackReasonWireUnroute,
                CallbackReasonWireUncomp,
                CallbackReasonWireTerminals,
                CallbackReasonChoosePart,
                CallbackReasonCreateConnection,
                CallbackReasonEditConnection,
                CallbackReasonUnassignStock,
                CallbackReasonCreateRun,
                CallbackReasonRunPreDelete,
                CallbackReasonReplaceStock,
                CallbackReasonCreatePortConnection,
                CallbackReasonWireCompProxy,
                CallbackReasonReplacePart,
                CallbackReasonBrokenConnection,
                CallbackReasonEditReplacePart,
                CallbackReasonAttrDiscrepancy,
                CallbackReasonAttributeCopyReplacePart,
                CallbackReasonStockComponentCreated,
                CallbackReasonCount
            };
            public: 
            typedef NXOpen::Callback1<void, std::vector<NXOpen::NXObject *>> Callback;
            public: enum DesignRuleReason
            {
                DesignRuleReasonUnknown = -1,
                DesignRuleReasonCreatePath,
                DesignRuleReasonHealPath,
                DesignRuleReasonAssignCorner,
                DesignRuleReasonAssignStock,
                DesignRuleReasonRemoveStock,
                DesignRuleReasonStockStyle,
                DesignRuleReasonPlacePart,
                DesignRuleReasonCreateFabrication,
                DesignRuleReasonQualifyPart,
                DesignRuleReasonMovePath,
                DesignRuleReasonCopyPath,
                DesignRuleReasonDeletePath,
                DesignRuleReasonSubdivideSegment,
                DesignRuleReasonSimplifyPath,
                DesignRuleReasonRemovePart,
                DesignRuleReasonMovePart,
                DesignRuleReasonEditCharacteristic,
                DesignRuleReasonInteractive,
                DesignRuleReasonBatch,
                DesignRuleReasonOrientStock,
                DesignRuleReasonUnifyPath,
                DesignRuleReasonTransformPath,
                DesignRuleReasonOffsetPath,
                DesignRuleReasonAutoRoutePinLevel,
                DesignRuleReasonManualRoutePinLevel,
                DesignRuleReasonAutoRouteComponentLevel,
                DesignRuleReasonManualRouteComponentLevel,
                DesignRuleReasonImport,
                DesignRuleReasonSpaceReservation,
                DesignRuleReasonPartialAutoRoute,
                DesignRuleReasonPartialManualRoute,
                DesignRuleReasonWindCatcher,
                DesignRuleReasonCreatePlatform,
                DesignRuleReasonEditPlacePart,
                DesignRuleReasonBulkReplacement,
                DesignRuleReasonReparentParts,
                DesignRuleReasonCablewayValidation,
                DesignRuleReasonEditTemplateParameters,
                DesignRuleReasonSpline,
                DesignRuleReasonEditPoint,
                DesignRuleReasonEndform,
                DesignRuleReasonPlaceElbows,
                DesignRuleReasonEditCutElbow,
                DesignRuleReasonInsulation,
                DesignRuleReasonConnectComponents,
                DesignRuleReasonDisconnectComponents,
                DesignRuleReasonDerivedPath,
                DesignRuleReasonSplitStock,
                DesignRuleReasonMergeStock,
                DesignRuleReasonEditPosition,
                DesignRuleReasonPlaceSplice,
                DesignRuleReasonCount
            };
            public: 
            typedef NXOpen::Callback2<void, NXOpen::Routing::CustomManager::DesignRuleReason, std::vector<NXOpen::NXObject *>> DesignRule;
            public: enum Application
            {
                ApplicationElectrical ,
                ApplicationMechanical
            };
            public: 
            typedef NXOpen::Callback1<void, NXOpen::Routing::CustomManager::Application> ApplicationEnterPlugin;
            public: 
            typedef NXOpen::Callback1<void, NXOpen::Routing::CustomManager::Application> ApplicationExitPlugin;
            public: 
            typedef NXOpen::Callback1<void, NXString> ImportExportPlugin;
            public: 
            typedef NXOpen::Callback0<NXString> PlmxmlObjectNamePlugin;
            public: 
            typedef NXOpen::Callback1<double, NXOpen::Routing::Overstock *> WrappedOverstockLengthCalculationPlugin;
            public: 
            typedef NXOpen::Callback4<bool, NXOpen::NXObject *, NXString, NXString, NXString> FilterBlankingPlugin;
            public: 
            typedef NXOpen::Callback0<void> BomPlugin;
            public: 
            typedef NXOpen::Callback1<int, std::vector<NXOpen::Routing::Electrical::Connection *>> AutoroutePlugin;
            public: 
            typedef NXOpen::Callback1<void, NXOpen::Routing::Electrical::SortConnectionsPluginData *> SortConnectionsPlugin;
            public: enum NavigatorType
            {
                NavigatorTypeComponent,
                NavigatorTypeConnection
            };

            public: enum SelectionType
            {
                SelectionTypeDeselected,
                SelectionTypeSelected
            };
            public: 
            typedef NXOpen::Callback3<void, NXOpen::Routing::CustomManager::NavigatorType, NXOpen::Routing::CustomManager::SelectionType, std::vector<NXOpen::NXObject *>> NavigatorObjectSelectedPlugin;
            public: 
            typedef NXOpen::Callback1<double, std::vector<NXOpen::Routing::StockData *>> BundlePlugin;
            public: 
            typedef NXOpen::Callback1<bool, std::vector<NXOpen::Routing::Electrical::HarnessDevice *>> ValidateFormboardPlugin;
            public: 
            typedef NXOpen::Callback1<bool, NXOpen::Routing::Stock *> StockComponentLockedPlugin;
            public: 
            typedef NXOpen::Callback1<void, std::vector<NXOpen::NXObject *>> UnifyPathPlugin;
            public: enum PipingComponentFileOptions
            {
                PipingComponentFileOptionsAskToOverwriteFile,
                PipingComponentFileOptionsNeverOverwriteFile,
                PipingComponentFileOptionsAlwaysOverwriteFile
            };
public: 
            typedef NXOpen::Callback3<void, NXString, std::vector<NXOpen::Assemblies::Component *>, NXOpen::Routing::CustomManager::PipingComponentFileOptions> PipingComponentFilePlugin;
            public: enum DuctSizeCalculatorDuctShape
            {
                DuctSizeCalculatorDuctShapeRectangular ,
                DuctSizeCalculatorDuctShapeCircular ,
                DuctSizeCalculatorDuctShapeFlatOval
            };
            public: 
            typedef NXOpen::Callback5<void, std::vector<NXOpen::Curve *>, NXOpen::Routing::CustomManager::DuctSizeCalculatorDuctShape, double, double, double> DuctSizeCalculatorCreateStockPlugin;
            public: enum DuctSizeCalculatorDisplayNoteFlag
            {
                DuctSizeCalculatorDisplayNoteFlagAddNote ,
                DuctSizeCalculatorDisplayNoteFlagRemoveNote
            };
            public: 
            typedef NXOpen::Callback2<void, NXOpen::Curve *, NXOpen::Routing::CustomManager::DuctSizeCalculatorDisplayNoteFlag> DuctSizeCalculatorDisplayNotePlugin;
            public: 
            typedef NXOpen::Callback2<void, NXString, NXString> DisciplineChangedPlugin;
            public: 
            typedef NXOpen::Callback2<void, NXString, NXString> SpecificationChangedPlugin;
            public: 
            typedef NXOpen::Callback1<int, NXOpen::Routing::ChoosePartPluginData *> ChoosePartPlugin;
            public: 
            typedef NXOpen::Callback1<void, NXOpen::Routing::ComponentNamePluginData *> ComponentNamePlugin;
            public: 
            typedef NXOpen::Callback1<NXString, NXOpen::Routing::Stock *> GenerateStockComponentNameplugin;
            public: 
            typedef NXOpen::Callback3<NXString, NXString, NXString, NXString> GeneratePLMXMLFileNamePluginForBulkExport;
            private: CustomManagerImpl * m_custommanager_impl;
            private: NXOpen::Session* m_owner;
            public: explicit CustomManager(NXOpen::Session *owner);
            public:
            tag_t Tag() const;
            public: ~CustomManager();
            public: int AddCallback
            (
                NXOpen::Routing::CustomManager::CallbackReason reason ,
                const NXOpen::Routing::CustomManager::Callback&  callbackMethod 
            );
            public: void RemoveCallback
            (
                int callbackMethodId 
            );
            public: void RemoveAllCallbacksForReason
            (
                NXOpen::Routing::CustomManager::CallbackReason reason 
            );
            public: void RemoveAllCallbacks
            (
            );
            public: void GetCallbacksRegisteredForReason
            (
                NXOpen::Routing::CustomManager::CallbackReason reason ,
                std::vector<int> & registeredCallbackIds 
            );
            public: int AddDesignRule
            (
                NXOpen::Routing::CustomManager::DesignRuleReason reason ,
                const NXString & name ,
                const NXString & description ,
                const NXOpen::Routing::CustomManager::DesignRule&  designRuleMethod 
            );
            int AddDesignRule
            (
                NXOpen::Routing::CustomManager::DesignRuleReason reason ,
                const char * name ,
                const char * description ,
                const NXOpen::Routing::CustomManager::DesignRule&  designRuleMethod 
            );
            public: void RemoveDesignRule
            (
                int designRuleMethodId 
            );
            public: void RemoveAllDesignRulesForReason
            (
                NXOpen::Routing::CustomManager::DesignRuleReason reason 
            );
            public: void RemoveAllDesignRules
            (
            );
            public: void GetDesignRulesRegisteredForReason
            (
                NXOpen::Routing::CustomManager::DesignRuleReason reason ,
                std::vector<int> & registeredDesignRuleIds 
            );
            public: std::vector<NXOpen::Routing::DesignRuleViolation *> GetViolationsForReason
            (
                NXOpen::Routing::CustomManager::DesignRuleReason reason 
            );
            public: std::vector<NXOpen::Routing::DesignRuleViolation *> GetViolationsOfRule
            (
                const NXString & designRuleName 
            );
            std::vector<NXOpen::Routing::DesignRuleViolation *> GetViolationsOfRule
            (
                const char * designRuleName 
            );
            public: NXOpen::Routing::DesignRuleViolation * CreateViolationForReason
            (
                const NXString & designRuleName ,
                NXOpen::Routing::CustomManager::DesignRuleReason reason ,
                const NXString & shortDescription ,
                const NXString & longDescription ,
                const std::vector<NXOpen::NXObject *> & objects 
            );
            NXOpen::Routing::DesignRuleViolation * CreateViolationForReason
            (
                const char * designRuleName ,
                NXOpen::Routing::CustomManager::DesignRuleReason reason ,
                const char * shortDescription ,
                const char * longDescription ,
                const std::vector<NXOpen::NXObject *> & objects 
            );
            public: void DeleteViolationsOnObjectForReason
            (
                NXOpen::Routing::CustomManager::DesignRuleReason reason ,
                NXOpen::NXObject * nxObject 
            );
            public: void DeleteViolationsOfRuleOnObject
            (
                const NXString & designRuleName ,
                NXOpen::NXObject * nxObject 
            );
            void DeleteViolationsOfRuleOnObject
            (
                const char * designRuleName ,
                NXOpen::NXObject * nxObject 
            );
            public: void RemoveAllPlugins
            (
            );
            public: void SetApplicationEnterPlugin
            (
                const NXOpen::Routing::CustomManager::ApplicationEnterPlugin&  applicationEnterPlugin 
            );
            public: void RemoveApplicationEnterPlugin
            (
            );
            public: void SetApplicationExitPlugin
            (
                const NXOpen::Routing::CustomManager::ApplicationExitPlugin&  applicationExitPlugin 
            );
            public: void RemoveApplicationExitPlugin
            (
            );
            public: void SetHrnPreImportPlugin
            (
                const NXOpen::Routing::CustomManager::ImportExportPlugin&  hrnPreImportPlugin 
            );
            public: void RemoveHrnPreImportPlugin
            (
            );
            public: void SetHrnPostExportPlugin
            (
                const NXOpen::Routing::CustomManager::ImportExportPlugin&  hrnPostExportPlugin 
            );
            public: void RemoveHrnPostExportPlugin
            (
            );
            public: void SetCmpPreImportPlugin
            (
                const NXOpen::Routing::CustomManager::ImportExportPlugin&  cmpPreImportPlugin 
            );
            public: void RemoveCmpPreImportPlugin
            (
            );
            public: void SetCmpPostExportPlugin
            (
                const NXOpen::Routing::CustomManager::ImportExportPlugin&  cmpPostExportPlugin 
            );
            public: void RemoveCmpPostExportPlugin
            (
            );
            public: void SetPlmXmlPreImportPlugin
            (
                const NXOpen::Routing::CustomManager::ImportExportPlugin&  plmXmlPreImportPlugin 
            );
            public: void RemovePlmXmlPreImportPlugin
            (
            );
            public: void SetPlmXmlPostExportPlugin
            (
                const NXOpen::Routing::CustomManager::ImportExportPlugin&  plmXmlPostExportPlugin 
            );
            public: void RemovePlmXmlPostExportPlugin
            (
            );
            public: void SetPlmXmlRouteNodeNamePlugin
            (
                const NXOpen::Routing::CustomManager::PlmxmlObjectNamePlugin&  plmXmlRouteNodeNamePlugin 
            );
            public: void RemovePlmXmlRouteNodeNamePlugin
            (
            );
            public: void SetPlmXmlRouteSectionNamePlugin
            (
                const NXOpen::Routing::CustomManager::PlmxmlObjectNamePlugin&  plmXmlRouteSectionNamePlugin 
            );
            public: void RemovePlmXmlRouteSectionNamePlugin
            (
            );
            public: void SetWrappedOverstockLengthCalculationPlugin
            (
                const NXOpen::Routing::CustomManager::WrappedOverstockLengthCalculationPlugin&  lengthCalculationPlugin 
            );
            public: void RemoveWrappedOverstockLengthCalculationPlugin
            (
            );
            public: void SetFilterBlankingPlugin
            (
                const NXOpen::Routing::CustomManager::FilterBlankingPlugin&  filterBlankingPlugin 
            );
            public: void RemoveFilterBlankingPlugin
            (
            );
            public: void SetBomPlugin
            (
                const NXOpen::Routing::CustomManager::BomPlugin&  bomPlugin 
            );
            public: void RemoveBomPlugin
            (
            );
            public: void SetAutoRoutePlugin
            (
                const NXOpen::Routing::CustomManager::AutoroutePlugin&  autoRoutePlugin 
            );
            public: void RemoveAutoRoutePlugin
            (
            );
            public: void SetManualRoutePlugin
            (
                const NXOpen::Routing::CustomManager::AutoroutePlugin&  manualRoutePlugin 
            );
            public: void RemoveManualRoutePlugin
            (
            );
            public: void SetUnroutePlugin
            (
                const NXOpen::Routing::CustomManager::AutoroutePlugin&  unroutePlugin 
            );
            public: void RemoveUnroutePlugin
            (
            );
            public: void SetSortConnectionsPlugin
            (
                const NXOpen::Routing::CustomManager::SortConnectionsPlugin&  sortConnectionsPlugin 
            );
            public: void RemoveSortConnectionsPlugin
            (
            );
            public: void SetNavigatorObjectSelectedPlugin
            (
                const NXOpen::Routing::CustomManager::NavigatorObjectSelectedPlugin&  navigatorObjectSelectedPlugin 
            );
            public: void RemoveNavigatorObjectSelectedPlugin
            (
            );
            public: void SetBundlePlugin
            (
                const NXOpen::Routing::CustomManager::BundlePlugin&  bundlePlugin 
            );
            public: void RemoveBundlePlugin
            (
            );
            public: void SetValidateFormboardPlugin
            (
                const NXOpen::Routing::CustomManager::ValidateFormboardPlugin&  validateFormboardPlugin 
            );
            public: void RemoveValidateFormboardPlugin
            (
            );
            public: void SetStockComponentLockedPlugin
            (
                const NXOpen::Routing::CustomManager::StockComponentLockedPlugin&  stockComponentLockedPlugin 
            );
            public: void RemoveStockComponentLockedPlugin
            (
            );
            public: void SetUnifyPathPlugin
            (
                const NXOpen::Routing::CustomManager::UnifyPathPlugin&  unifyPathPlugin 
            );
            public: void RemoveUnifyPathPlugin
            (
            );
            public: void SetPipingComponentFilePlugin
            (
                const NXOpen::Routing::CustomManager::PipingComponentFilePlugin&  pipingComponentFilePlugin 
            );
            public: void RemovePipingComponentFilePlugin
            (
            );
            public: void SetDuctSizeCalculatorCreateStockPlugin
            (
                const NXOpen::Routing::CustomManager::DuctSizeCalculatorCreateStockPlugin&  createStockPlugin 
            );
            public: void RemoveDuctSizeCalculatorCreateStockPlugin
            (
            );
            public: void SetDuctSizeCalculatorDisplayNotePlugin
            (
                const NXOpen::Routing::CustomManager::DuctSizeCalculatorDisplayNotePlugin&  displayNotePlugin 
            );
            public: void RemoveDuctSizeCalculatorDisplayNotePlugin
            (
            );
            public: void SetDisciplineChangedPlugin
            (
                const NXOpen::Routing::CustomManager::DisciplineChangedPlugin&  disciplineChangedPlugin 
            );
            public: void RemoveDisciplineChangedPlugin
            (
            );
            public: void SetSpecificationChangedPlugin
            (
                const NXOpen::Routing::CustomManager::SpecificationChangedPlugin&  specificationChangedPlugin 
            );
            public: void RemoveSpecificationChangedPlugin
            (
            );
            public: void SetChoosePartPlugin
            (
                const NXOpen::Routing::CustomManager::ChoosePartPlugin&  choosePartPlugin 
            );
            public: void RemoveChoosePartPlugin
            (
            );
            public: void SetStockComponentNamePlugin
            (
                const NXOpen::Routing::CustomManager::ComponentNamePlugin&  stockComponentNamePlugin 
            );
            public: void RemoveStockComponentNamePlugin
            (
            );
            public: void SetTemporaryStockComponentNamePlugin
            (
                const NXOpen::Routing::CustomManager::ComponentNamePlugin&  stockComponentNamePlugin 
            );
            public: void RemoveTemporaryStockComponentNamePlugin
            (
            );
            public: void SetCutElbowComponentNamePlugin
            (
                const NXOpen::Routing::CustomManager::ComponentNamePlugin&  cutElbowComponentNamePlugin 
            );
            public: void RemoveCutElbowComponentNamePlugin
            (
            );
            public: void SetGenerateStockComponentNamePlugin
            (
                const NXOpen::Routing::CustomManager::GenerateStockComponentNameplugin&  generateStockComponentNamePlugin 
            );
            public: void RemoveGenerateStockComponentNamePlugin
            (
            );
            public: void SetGeneratePLMXMLFileNamePluginForBulkExport
            (
                const NXOpen::Routing::CustomManager::GeneratePLMXMLFileNamePluginForBulkExport&  partName 
            );
            public: void RemoveGeneratePLMXMLFileNamePluginForBulkExport
            (
            );
        }; //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