The Routing Custom Manager allows you to customize Routing by setting session wide Routing preferences and by adding plugins, callbacks, and design rules. More...

Public Types
typedef NXOpen::Callback1< int, std::vector < NXOpen::Routing::Electrical::Connection * > >	AutoroutePlugin
	This defines the prototype for the autoroute plugin. More...

typedef NXOpen::Callback0< void >	BomPlugin
	This defines the prototype for the bill of materials plugin. More...

typedef NXOpen::Callback1 < double, std::vector < NXOpen::Routing::StockData * > >	BundlePlugin
	This defines the prototype Routing calls to determine the bundle diameter for each bundle in a harness. More...

typedef NXOpen::Callback1 < void, std::vector < NXOpen::NXObject * > >	Callback
	This defines the prototype for all Routing callbacks. More...

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, CallbackReasonCount }
	The reason for registering a callback indicates which Routing commands will use the callback. More...

typedef NXOpen::Callback1< int, NXOpen::Routing::ChoosePartPluginData * >	ChoosePartPlugin
	This defines the prototype for the choose part plugin used by the Place Part command. More...

typedef NXOpen::Callback2 < void, NXOpen::Routing::CustomManager::DesignRuleReason, std::vector< NXOpen::NXObject * > >	DesignRule
	This defines the prototype for all Routing design rules. More...

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, DesignRuleReasonCount }
	The reason for registering a design rule indicates which Routing commands will use the design rule. More...

typedef NXOpen::Callback2 < void, NXString, NXString >	DisciplineChangedPlugin
	This defines the prototype for the Discipline Changed plugin. More...

typedef NXOpen::Callback5 < void, std::vector < NXOpen::Curve * > , NXOpen::Routing::CustomManager::DuctSizeCalculatorDuctShape, double, double, double >	DuctSizeCalculatorCreateStockPlugin
	This defines the prototype for the Duct Size Calculator's Create Stock plugin. More...

enum	DuctSizeCalculatorDisplayNoteFlag { DuctSizeCalculatorDisplayNoteFlagAddNote, DuctSizeCalculatorDisplayNoteFlagRemoveNote }
	Used by the Duct Size Calculator's display note plugin to indicate whether to add or remove the note. More...

typedef NXOpen::Callback2 < void, NXOpen::Curve *, NXOpen::Routing::CustomManager::DuctSizeCalculatorDisplayNoteFlag >	DuctSizeCalculatorDisplayNotePlugin
	This defines the prototype for the Duct Size Calculator's Display Note plugin. More...

enum	DuctSizeCalculatorDuctShape { DuctSizeCalculatorDuctShapeRectangular, DuctSizeCalculatorDuctShapeCircular, DuctSizeCalculatorDuctShapeFlatOval }
	Used by the Duct Size Calculator's create stock plugin to indicate what shape stock to create. More...

typedef NXOpen::Callback4 < bool, NXOpen::NXObject *, NXString, NXString, NXString >	FilterBlankingPlugin
	This defines the prototype for the filter blanking plugin. More...

typedef NXOpen::Callback1 < void, NXString >	ImportExportPlugin
	This defines the prototype for the import export plugins. More...

typedef NXOpen::Callback3 < void, NXOpen::Routing::CustomManager::NavigatorType, NXOpen::Routing::CustomManager::SelectionType, std::vector< NXOpen::NXObject * > >	NavigatorObjectSelectedPlugin
	This defines the prototype Routing calls whenever an object on the Component or Connection Navigator is selected or deselected. More...

enum	NavigatorType { NavigatorTypeComponent, NavigatorTypeConnection }
	Used by the navigator object selected plugin to indicate in which navigator the objects were selected. More...

enum	PipingComponentFileOptions { PipingComponentFileOptionsAskToOverwriteFile, PipingComponentFileOptionsNeverOverwriteFile, PipingComponentFileOptionsAlwaysOverwriteFile }
	Used by the piping component file plugin to indicate if it should overwrite an existing file or not. More...

typedef NXOpen::Callback3 < void, NXString, std::vector < NXOpen::Assemblies::Component * > , NXOpen::Routing::CustomManager::PipingComponentFileOptions >	PipingComponentFilePlugin
	This defines the prototype for the piping component file plugin. More...

typedef NXOpen::Callback0 < NXString >	PlmxmlObjectNamePlugin
	This defines the prototype for the Route Node and Route Section name plugins. More...

enum	SelectionType { SelectionTypeDeselected, SelectionTypeSelected }
	Used by the navigator object selected plugin to indicate whether the objects are selected or deselected. More...

typedef NXOpen::Callback1 < void, NXOpen::Routing::Electrical::SortConnectionsPluginData * >	SortConnectionsPlugin
	This defines the prototype for the sort connections plugin in which you can sort the connections in the order Routing will route them along their paths. More...

typedef NXOpen::Callback2 < void, NXString, NXString >	SpecificationChangedPlugin
	This defines the prototype for the Specification Changed plugin. More...

typedef NXOpen::Callback1 < bool, NXOpen::Routing::Stock * >	StockComponentLockedPlugin
	This defines the prototype for the stock component locked plugin. More...

typedef NXOpen::Callback1 < void, std::vector < NXOpen::NXObject * > >	UnifyPathPlugin
	This defines the prototype for the unify path plugin. More...

typedef NXOpen::Callback1 < bool, std::vector < NXOpen::Routing::Electrical::HarnessDevice * > >	ValidateFormboardPlugin
	This defines the prototype for the validate formboard plugin. More...

typedef NXOpen::Callback1 < double, NXOpen::Routing::Overstock * >	WrappedOverstockLengthCalculationPlugin
	This defines the prototype for the wrapped overstock length calculation plugin. More...

Public Member Functions
int	AddCallback (NXOpen::Routing::CustomManager::CallbackReason reason, const NXOpen::Routing::CustomManager::Callback &callbackMethod)
	Adds the callback with the given reason. More...

int	AddDesignRule (NXOpen::Routing::CustomManager::DesignRuleReason reason, const NXString &name, const NXString &description, const NXOpen::Routing::CustomManager::DesignRule &designRuleMethod)
	Adds the design rule with the given reason. More...

int	AddDesignRule (NXOpen::Routing::CustomManager::DesignRuleReason reason, const char name, const char description, const NXOpen::Routing::CustomManager::DesignRule &designRuleMethod)
	Adds the design rule with the given reason. More...

NXOpen::Routing::DesignRuleViolation *	CreateViolationForReason (const NXString &designRuleName, NXOpen::Routing::CustomManager::DesignRuleReason reason, const NXString &shortDescription, const NXString &longDescription, const std::vector< NXOpen::NXObject * > &objects)
	Creates a new violation for a design rule reason. More...

NXOpen::Routing::DesignRuleViolation *	CreateViolationForReason (const char designRuleName, NXOpen::Routing::CustomManager::DesignRuleReason reason, const char shortDescription, const char longDescription, const std::vector< NXOpen::NXObject > &objects)
	Creates a new violation for a design rule reason. More...

void	DeleteViolationsOfRuleOnObject (const NXString &designRuleName, NXOpen::NXObject *nxObject)
	Finds the violation of a design rule attached to the given object and deletes it. More...

void	DeleteViolationsOfRuleOnObject (const char designRuleName, NXOpen::NXObject nxObject)
	Finds the violation of a design rule attached to the given object and deletes it. More...

void	DeleteViolationsOnObjectForReason (NXOpen::Routing::CustomManager::DesignRuleReason reason, NXOpen::NXObject *nxObject)
	Finds the violation of a design rule reason attached to the given object and deletes it. More...

void	GetCallbacksRegisteredForReason (NXOpen::Routing::CustomManager::CallbackReason reason, std::vector< int > &registeredCallbackIds)
	Returns the callbacks, if any, registered for the given reason. More...

void	GetDesignRulesRegisteredForReason (NXOpen::Routing::CustomManager::DesignRuleReason reason, std::vector< int > &registeredDesignRuleIds)
	Returns the design rules, if any, registered for the given reason. More...

std::vector < NXOpen::Routing::DesignRuleViolation * >	GetViolationsForReason (NXOpen::Routing::CustomManager::DesignRuleReason reason)
	Returns any violations recorded against a design rule reason. More...

std::vector < NXOpen::Routing::DesignRuleViolation * >	GetViolationsOfRule (const NXString &designRuleName)
	Returns any violations recorded against a design rule. More...

std::vector < NXOpen::Routing::DesignRuleViolation * >	GetViolationsOfRule (const char *designRuleName)
	Returns any violations recorded against a design rule. More...

void	RemoveAllCallbacks ()
	Removes all the registered callbacks, except those configured in the Application View (APV) file. More...

void	RemoveAllCallbacksForReason (NXOpen::Routing::CustomManager::CallbackReason reason)
	Removes all the callbacks registered for a particular reason. More...

void	RemoveAllDesignRules ()
	Removes all the registered design rules, except those configured in the Application View (APV) file. More...

void	RemoveAllDesignRulesForReason (NXOpen::Routing::CustomManager::DesignRuleReason reason)
	Removes all the design rules registered for a particular reason. More...

void	RemoveAllPlugins ()
	Removes all the registered plugins, except those configured in the Application View (APV) file. More...

void	RemoveAutoRoutePlugin ()
	Removes any registered autoroute plugin, except one configured in the Application View (APV) file. More...

void	RemoveBomPlugin ()
	Removes any registered bill of materials plugin, except one configured in the Application View (APV) file. More...

void	RemoveBundlePlugin ()
	Removes any registered bundle plugin, except one configured in the Application View (APV) file. More...

void	RemoveCallback (int callbackMethodId)
	Removes the registered callback. More...

void	RemoveChoosePartPlugin ()
	Removes any registered choose part plugin, except one configured in the Application View (APV) file. More...

void	RemoveCmpPostExportPlugin ()
	Removes any registered post-export CMP plugin, except one configured in the Application View (APV) file. More...

void	RemoveCmpPreImportPlugin ()
	Removes any registered pre-import CMP plugin, except one configured in the Application View (APV) file. More...

void	RemoveDesignRule (int designRuleMethodId)
	Removes the registered design rule. More...

void	RemoveDisciplineChangedPlugin ()
	Removes any registered discpline changed plugin. More...

void	RemoveDuctSizeCalculatorCreateStockPlugin ()
	Removes any registered create stock plugin, except one configured in the Application View (APV) file. More...

void	RemoveDuctSizeCalculatorDisplayNotePlugin ()
	Removes any registered display note plugin, except one configured in the Application View (APV) file. More...

void	RemoveFilterBlankingPlugin ()
	Removes any registered filter blanking plugin, except one configured in the Application View (APV) file. More...

void	RemoveHrnPostExportPlugin ()
	Removes any registered post-export HRN plugin, except one configured in the Application View (APV) file. More...

void	RemoveHrnPreImportPlugin ()
	Removes any registered pre-import HRN plugin, except one configured in the Application View (APV) file. More...

void	RemoveManualRoutePlugin ()
	Removes any registered manual route plugin, except one configured in the Application View (APV) file. More...

void	RemoveNavigatorObjectSelectedPlugin ()
	Removes any registered navigator object selected plugin, except one configured in the Application View (APV) file. More...

void	RemovePipingComponentFilePlugin ()
	Removes any registered piping component file plugin, except one configured in the Application View (APV) file. More...

void	RemovePlmXmlPostExportPlugin ()
	Removes any registered post-export PLMXML plugin, except one configured in the Application View (APV) file. More...

void	RemovePlmXmlPreImportPlugin ()
	Removes any registered pre-import PLMXML plugin, except one configured in the Application View (APV) file. More...

void	RemovePlmXmlRouteNodeNamePlugin ()
	Removes any registered Route Node name plugin, except one configured in the Application View (APV) file. More...

void	RemovePlmXmlRouteSectionNamePlugin ()
	Removes any registered Route Section name plugin, except one configured in the Application View (APV) file. More...

void	RemoveSortConnectionsPlugin ()
	Removes any registered sort connections plugin. More...

void	RemoveSpecificationChangedPlugin ()
	Removes any registered discpline changed plugin. More...

void	RemoveStockComponentLockedPlugin ()
	Removes any registered stock component locked plugin, except one configured in the Application View (APV) file. More...

void	RemoveUnifyPathPlugin ()
	Removes any registered unify path plugin, except one configured in the Application View (APV) file. More...

void	RemoveUnroutePlugin ()
	Removes any registered unroute plugin, except one configured in the Application View (APV) file. More...

void	RemoveValidateFormboardPlugin ()
	Removes any registered validate formboard plugin, except one configured in the Application View (APV) file. More...

void	RemoveWrappedOverstockLengthCalculationPlugin ()
	Removes any registered wrapped overstock length calculation plugin, except one configured in the Application View (APV) file. More...

void	SetAutoRoutePlugin (const NXOpen::Routing::CustomManager::AutoroutePlugin &autoRoutePlugin)
	Sets the plugin Routing will instead of the internal automatic routing of connections along a path. More...

void	SetBomPlugin (const NXOpen::Routing::CustomManager::BomPlugin &bomPlugin)
	Sets the plugin called just after Routing creates a bill of materials. More...

void	SetBundlePlugin (const NXOpen::Routing::CustomManager::BundlePlugin &bundlePlugin)
	Sets the plugin Routing will call to determine the bundle diameter for each bundle in a harness. More...

void	SetChoosePartPlugin (const NXOpen::Routing::CustomManager::ChoosePartPlugin &choosePartPlugin)
	Sets the choose part plugin. More...

void	SetCmpPostExportPlugin (const NXOpen::Routing::CustomManager::ImportExportPlugin &cmpPostExportPlugin)
	Sets the plugin called just after Routing exports an CMP file. More...

void	SetCmpPreImportPlugin (const NXOpen::Routing::CustomManager::ImportExportPlugin &cmpPreImportPlugin)
	Sets the plugin called before importing an CMP file. More...

void	SetDisciplineChangedPlugin (const NXOpen::Routing::CustomManager::DisciplineChangedPlugin &disciplineChangedPlugin)
	Sets the plugin Routing will use to display a note on the segments selected in the Duct Size Calculator. More...

void	SetDuctSizeCalculatorCreateStockPlugin (const NXOpen::Routing::CustomManager::DuctSizeCalculatorCreateStockPlugin &createStockPlugin)
	Sets the plugin Routing will use to create stock for the Duct Size Calculator command. More...

void	SetDuctSizeCalculatorDisplayNotePlugin (const NXOpen::Routing::CustomManager::DuctSizeCalculatorDisplayNotePlugin &displayNotePlugin)
	Sets the plugin Routing will use to display a note on the segments selected in the Duct Size Calculator. More...

void	SetFilterBlankingPlugin (const NXOpen::Routing::CustomManager::FilterBlankingPlugin &filterBlankingPlugin)
	Sets the plugin called by Routing to determine if a segment or component needs to be blanked. More...

void	SetHrnPostExportPlugin (const NXOpen::Routing::CustomManager::ImportExportPlugin &hrnPostExportPlugin)
	Sets the plugin called just after Routing exports an HRN file. More...

void	SetHrnPreImportPlugin (const NXOpen::Routing::CustomManager::ImportExportPlugin &hrnPreImportPlugin)
	Sets the plugin called before importing an HRN file. More...

void	SetManualRoutePlugin (const NXOpen::Routing::CustomManager::AutoroutePlugin &manualRoutePlugin)
	Sets the plugin Routing will instead of the internal manual routing of connections along a path. More...

void	SetNavigatorObjectSelectedPlugin (const NXOpen::Routing::CustomManager::NavigatorObjectSelectedPlugin &navigatorObjectSelectedPlugin)
	Sets the plugin Routing will call whenever an object on the Component or Connection Navigator is selected or deselected. More...

void	SetPipingComponentFilePlugin (const NXOpen::Routing::CustomManager::PipingComponentFilePlugin &pipingComponentFilePlugin)
	Sets the plugin Routing will use for the Unify Path command. More...

void	SetPlmXmlPostExportPlugin (const NXOpen::Routing::CustomManager::ImportExportPlugin &plmXmlPostExportPlugin)
	Sets the plugin called just after Routing exports an PLMXML file. More...

void	SetPlmXmlPreImportPlugin (const NXOpen::Routing::CustomManager::ImportExportPlugin &plmXmlPreImportPlugin)
	Sets the plugin called before importing an PLMXML file. More...

void	SetPlmXmlRouteNodeNamePlugin (const NXOpen::Routing::CustomManager::PlmxmlObjectNamePlugin &plmXmlRouteNodeNamePlugin)
	Sets the plugin Routing will call to get the name of the next Route Node for the PLMXML file. More...

void	SetPlmXmlRouteSectionNamePlugin (const NXOpen::Routing::CustomManager::PlmxmlObjectNamePlugin &plmXmlRouteSectionNamePlugin)
	Sets the plugin Routing will call to get the name of the next Route Section for the PLMXML file. More...

void	SetSortConnectionsPlugin (const NXOpen::Routing::CustomManager::SortConnectionsPlugin &sortConnectionsPlugin)
	Sets the plugin Routing will call to sort the connections about to be routed. More...

void	SetSpecificationChangedPlugin (const NXOpen::Routing::CustomManager::SpecificationChangedPlugin &specificationChangedPlugin)
	Sets the plugin Routing will use to display a note on the segments selected in the Duct Size Calculator. More...

void	SetStockComponentLockedPlugin (const NXOpen::Routing::CustomManager::StockComponentLockedPlugin &stockComponentLockedPlugin)
	Sets the plugin Routing will call to see if a stock component is modifiable. More...

void	SetUnifyPathPlugin (const NXOpen::Routing::CustomManager::UnifyPathPlugin &unifyPathPlugin)
	Sets the plugin Routing will use for the Unify Path command. More...

void	SetUnroutePlugin (const NXOpen::Routing::CustomManager::AutoroutePlugin &unroutePlugin)
	Sets the plugin Routing will instead of the internal unroute method. More...

void	SetValidateFormboardPlugin (const NXOpen::Routing::CustomManager::ValidateFormboardPlugin &validateFormboardPlugin)
	Sets the plugin Routing will call to validate the harnesses on a formboard. More...

void	SetWrappedOverstockLengthCalculationPlugin (const NXOpen::Routing::CustomManager::WrappedOverstockLengthCalculationPlugin &lengthCalculationPlugin)
	Sets the plugin called by Routing to calculate the length of a wrapped overstock. More...

tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

The Routing Custom Manager allows you to customize Routing by setting session wide Routing preferences and by adding plugins, callbacks, and design rules.

To obtain an instance of this class, refer to NXOpen::Session

Created in NX12.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<int, std::vector<NXOpen::Routing::Electrical::Connection *> > NXOpen::Routing::CustomManager::AutoroutePlugin

This defines the prototype for the autoroute plugin.

Returns the number of connections actually routed.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

typedef NXOpen::Callback0<void> NXOpen::Routing::CustomManager::BomPlugin

This defines the prototype for the bill of materials plugin.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

typedef NXOpen::Callback1<double, std::vector<NXOpen::Routing::StockData *> > NXOpen::Routing::CustomManager::BundlePlugin

This defines the prototype Routing calls to determine the bundle diameter for each bundle in a harness.

It returns the diameter of the bundle Routing should create to represent the given stock.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

typedef NXOpen::Callback1<void, std::vector<NXOpen::NXObject *> > NXOpen::Routing::CustomManager::Callback

This defines the prototype for all Routing callbacks.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

typedef NXOpen::Callback1<int, NXOpen::Routing::ChoosePartPluginData *> NXOpen::Routing::CustomManager::ChoosePartPlugin

This defines the prototype for the choose part plugin used by the Place Part command.

You can use this plugin to choose any part you wish to be placed by the Place Part command.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

typedef NXOpen::Callback2<void, NXOpen::Routing::CustomManager::DesignRuleReason, std::vector<NXOpen::NXObject *> > NXOpen::Routing::CustomManager::DesignRule

This defines the prototype for all Routing design rules.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

typedef NXOpen::Callback2<void, NXString, NXString> NXOpen::Routing::CustomManager::DisciplineChangedPlugin

This defines the prototype for the Discipline Changed plugin.

Routing calls this plugin any time the user changes the discipline.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

typedef NXOpen::Callback5<void, std::vector<NXOpen::Curve *>, NXOpen::Routing::CustomManager::DuctSizeCalculatorDuctShape, double, double, double> NXOpen::Routing::CustomManager::DuctSizeCalculatorCreateStockPlugin

This defines the prototype for the Duct Size Calculator's Create Stock plugin.

This plugin should take the given parameters and create either circular, rectangular or flat oval space reservation on the given segments.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

typedef NXOpen::Callback2<void, NXOpen::Curve *, NXOpen::Routing::CustomManager::DuctSizeCalculatorDisplayNoteFlag> NXOpen::Routing::CustomManager::DuctSizeCalculatorDisplayNotePlugin

This defines the prototype for the Duct Size Calculator's Display Note plugin.

This plugin displays notes with values of user specified attributes on the selected segments.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

typedef NXOpen::Callback4<bool, NXOpen::NXObject *, NXString, NXString, NXString> NXOpen::Routing::CustomManager::FilterBlankingPlugin

This defines the prototype for the filter blanking plugin.

Determines whether or not the segment or component should be blanked based on the value of its filter blanking attribute.

Return true to blank the segment or component. False to unblank it.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

typedef NXOpen::Callback1<void, NXString> NXOpen::Routing::CustomManager::ImportExportPlugin

This defines the prototype for the import export plugins.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

typedef NXOpen::Callback3<void, NXOpen::Routing::CustomManager::NavigatorType, NXOpen::Routing::CustomManager::SelectionType, std::vector<NXOpen::NXObject *> > NXOpen::Routing::CustomManager::NavigatorObjectSelectedPlugin

This defines the prototype Routing calls whenever an object on the Component or Connection Navigator is selected or deselected.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

typedef NXOpen::Callback3<void, NXString, std::vector<NXOpen::Assemblies::Component *>, NXOpen::Routing::CustomManager::PipingComponentFileOptions> NXOpen::Routing::CustomManager::PipingComponentFilePlugin

This defines the prototype for the piping component file plugin.

The Piping Component File is then used by Alias' Isogen program to create an isometric drawing of the given components. This plugin will read the given components and write them to the piping component file in the proper format.

If the filename is NULL, it is up to the piping component file plugin to come up with a file name.

If the components array is empty, it is up to the piping component file plugin to either write out all components under the work part or prompt the user for the components to write.

Created in NX12.0.0.

License requirements : routing_pipetube ("Routing Piping and Tubing")

typedef NXOpen::Callback0<NXString> NXOpen::Routing::CustomManager::PlmxmlObjectNamePlugin

This defines the prototype for the Route Node and Route Section name plugins.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

typedef NXOpen::Callback1<void, NXOpen::Routing::Electrical::SortConnectionsPluginData *> NXOpen::Routing::CustomManager::SortConnectionsPlugin

This defines the prototype for the sort connections plugin in which you can sort the connections in the order Routing will route them along their paths.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

typedef NXOpen::Callback2<void, NXString, NXString> NXOpen::Routing::CustomManager::SpecificationChangedPlugin

This defines the prototype for the Specification Changed plugin.

Routing calls this plugin any time the user changes the specification.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

typedef NXOpen::Callback1<bool, NXOpen::Routing::Stock *> NXOpen::Routing::CustomManager::StockComponentLockedPlugin

This defines the prototype for the stock component locked plugin.

Returns whether or not the given stock component is modifiable because it is not locked.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

typedef NXOpen::Callback1<void, std::vector<NXOpen::NXObject *> > NXOpen::Routing::CustomManager::UnifyPathPlugin

This defines the prototype for the unify path plugin.

Displays a dialog that allows the users to select new characteristics to use when replacing all of the given objects.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

typedef NXOpen::Callback1<bool, std::vector<NXOpen::Routing::Electrical::HarnessDevice *> > NXOpen::Routing::CustomManager::ValidateFormboardPlugin

This defines the prototype for the validate formboard plugin.

Returns whether or not the given harnesses pass the validation test.

Created in NX12.0.0.

License requirements : routing_harness ("Routing Harness")

typedef NXOpen::Callback1<double, NXOpen::Routing::Overstock *> NXOpen::Routing::CustomManager::WrappedOverstockLengthCalculationPlugin

This defines the prototype for the wrapped overstock length calculation plugin.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Member Enumeration Documentation

enum NXOpen::Routing::CustomManager::CallbackReason

The reason for registering a callback indicates which Routing commands will use the callback.

Enumerator
CallbackReasonUnknown	Used only for validation.
CallbackReasonPlacePart	Called after the Place Part command.
CallbackReasonMovePart	Called after the Move Part command.
CallbackReasonRemovePart	Called after the Remove Part command.
CallbackReasonMovePath	Called after the Move Path command.
CallbackReasonCopyPath	Called after the Copy Path command.
CallbackReasonDeletePath	Called after the Delete Path command.
CallbackReasonTransformPath	Called after the Transform Path command.
CallbackReasonOffsetPath	Called after the Offset Path command.
CallbackReasonAssignStock	Called after the Assign Stock command.
CallbackReasonWireRouteManual	Called after the Manual Route command.
CallbackReasonWireRouteAuto	Called after the AutoRoute command.
CallbackReasonWireCompManual	Called after the Manual Assign command.
CallbackReasonWireCompAuto	Called after the AutoAssign command.
CallbackReasonWireUnroute	Called after the Unroute command.
CallbackReasonWireUncomp	Called after the Unassign Component command.
CallbackReasonWireTerminals	Called after the Model Terminals command.
CallbackReasonChoosePart	Called after the Choose Part command.
CallbackReasonCreateConnection	Called after the Create Connection command.
CallbackReasonEditConnection	Called after the Edit Connection command.
CallbackReasonUnassignStock	Called after the Remove Stock command.
CallbackReasonCreateRun	Called after the Create Run command.
CallbackReasonRunPreDelete	Called before deleting a run.
CallbackReasonReplaceStock	Called after the Replace Stock command.
CallbackReasonCreatePortConnection	Called after the creating a connection between two ports.
CallbackReasonWireCompProxy	Called after the Assign Proxy command.
CallbackReasonReplacePart	Called after the Replace Part command.
CallbackReasonBrokenConnection	Called after a port-to-port connection is broken.
CallbackReasonEditReplacePart	Unused.
CallbackReasonAttrDiscrepancy	Called after the Place Part and Replace Part commands.
CallbackReasonAttributeCopyReplacePart	Called after the Replace Part command.
CallbackReasonCount	The number of callback reasons.

enum NXOpen::Routing::CustomManager::DesignRuleReason

The reason for registering a design rule indicates which Routing commands will use the design rule.

NOTE: The Interactive Check command calls all design rules regardless of the reason for which you registered a design rule.

Enumerator
DesignRuleReasonUnknown	Used only for validation.
DesignRuleReasonCreatePath	Called after the Create Path command.
DesignRuleReasonHealPath	Called after the Heal Path command.
DesignRuleReasonAssignCorner	Called after the Assign Corner command.
DesignRuleReasonAssignStock	Called after the Assign Stock command.
DesignRuleReasonRemoveStock	Called after the Remove Stockcommand.
DesignRuleReasonStockStyle	Called after the Stock Style command.
DesignRuleReasonPlacePart	Called after the Place Part command.
DesignRuleReasonCreateFabrication	Called after the Create Fabrication command.
DesignRuleReasonQualifyPart	Called after the Qualify Part command.
DesignRuleReasonMovePath	Called after the Move Path command.
DesignRuleReasonCopyPath	Called after the Copy Path command.
DesignRuleReasonDeletePath	Called after the Delete Path command.
DesignRuleReasonSubdivideSegment	Called after the Subdivide Segment command.
DesignRuleReasonSimplifyPath	Called after the Simplify Path command.
DesignRuleReasonRemovePart	Called after the Remove Part command.
DesignRuleReasonMovePart	Called after the Move Part command.
DesignRuleReasonEditCharacteristic	Called after the Edit Characteristics command.
DesignRuleReasonInteractive	The design rule is called for an interactive check instead of after a particular command.
DesignRuleReasonBatch	Unused.
DesignRuleReasonOrientStock	Called after the Orient Stock command.
DesignRuleReasonUnifyPath	Called after the Unify Path command.
DesignRuleReasonTransformPath	Called after the Transform Path command.
DesignRuleReasonOffsetPath	Called after the Offset Path command.
DesignRuleReasonAutoRoutePinLevel	Called after the AutoRoute command using pin level routing.
DesignRuleReasonManualRoutePinLevel	Called after the Manual Route command using pin level routing.
DesignRuleReasonAutoRouteComponentLevel	Called after the AutoRoute command using component level routing.
DesignRuleReasonManualRouteComponentLevel	Called after the Manual Route command using component level routing.
DesignRuleReasonImport	Called after the Import command from the Routing Electrical application's navigators.
DesignRuleReasonSpaceReservation	Called after the Space Reservation command.
DesignRuleReasonPartialAutoRoute	Called after the Partial AutoRoute command.
DesignRuleReasonPartialManualRoute	Called after the Partial Manual Route command.
DesignRuleReasonWindCatcher	Called after the Wind Catcher command.
DesignRuleReasonCreatePlatform	Called after the Create Platform command.
DesignRuleReasonEditPlacePart	Called after the Edit Place Part command.
DesignRuleReasonCount	The number of design rule reasons.

enum NXOpen::Routing::CustomManager::DuctSizeCalculatorDisplayNoteFlag

Used by the Duct Size Calculator's display note plugin to indicate whether to add or remove the note.

Enumerator
DuctSizeCalculatorDisplayNoteFlagAddNote	add note
DuctSizeCalculatorDisplayNoteFlagRemoveNote	remove note

enum NXOpen::Routing::CustomManager::DuctSizeCalculatorDuctShape

Used by the Duct Size Calculator's create stock plugin to indicate what shape stock to create.

Enumerator
DuctSizeCalculatorDuctShapeRectangular	rectangular
DuctSizeCalculatorDuctShapeCircular	circular
DuctSizeCalculatorDuctShapeFlatOval	flat oval

enum NXOpen::Routing::CustomManager::NavigatorType

Used by the navigator object selected plugin to indicate in which navigator the objects were selected.

Enumerator
NavigatorTypeComponent	The objects were selected in the component navigator.
NavigatorTypeConnection	The objects were selected in the connection navigator.

enum NXOpen::Routing::CustomManager::PipingComponentFileOptions

Used by the piping component file plugin to indicate if it should overwrite an existing file or not.

Enumerator

PipingComponentFileOptionsAskToOverwriteFile

Prompt the user of the plugin if it is OK to overwrite the piping component file.

PipingComponentFileOptionsNeverOverwriteFile

Never overwrite any existing piping component file.

Throw an error if the file exists.

PipingComponentFileOptionsAlwaysOverwriteFile

Always overwrite any existing piping component file.

enum NXOpen::Routing::CustomManager::SelectionType

Used by the navigator object selected plugin to indicate whether the objects are selected or deselected.

Enumerator
SelectionTypeDeselected	The objects were deselected.
SelectionTypeSelected	The objects were selected.

Member Function Documentation

int NXOpen::Routing::CustomManager::AddCallback	(	NXOpen::Routing::CustomManager::CallbackReason	reason,
		const NXOpen::Routing::CustomManager::Callback &	callbackMethod
	)

Adds the callback with the given reason.

NOTE: You can register more than one callback with the same reason.

Returns: A unique identifier for your callback.
Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

reason	The reason for which you want this callback called.
callbackMethod	The method you want to be called.

int NXOpen::Routing::CustomManager::AddDesignRule	(	NXOpen::Routing::CustomManager::DesignRuleReason	reason,
		const NXString &	name,
		const NXString &	description,
		const NXOpen::Routing::CustomManager::DesignRule &	designRuleMethod
	)

Adds the design rule with the given reason.

NOTE: You can register more than one design rule with the same reason.

Returns: A unique identifier for your design rule.
Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

reason	The reason for which you want this design rule called.
name	A descriptive name for this design rule.
description	A detailed description of what this design rule checks.
designRuleMethod	The method you want to be called.

int NXOpen::Routing::CustomManager::AddDesignRule	(	NXOpen::Routing::CustomManager::DesignRuleReason	reason,
		const char *	name,
		const char *	description,
		const NXOpen::Routing::CustomManager::DesignRule &	designRuleMethod
	)

Adds the design rule with the given reason.

NOTE: You can register more than one design rule with the same reason.

Returns: A unique identifier for your design rule.
Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

reason	The reason for which you want this design rule called.
name	A descriptive name for this design rule.
description	A detailed description of what this design rule checks.
designRuleMethod	The method you want to be called.

NXOpen::Routing::DesignRuleViolation* NXOpen::Routing::CustomManager::CreateViolationForReason	(	const NXString &	designRuleName,
		NXOpen::Routing::CustomManager::DesignRuleReason	reason,
		const NXString &	shortDescription,
		const NXString &	longDescription,
		const std::vector< NXOpen::NXObject * > &	objects
	)

Creates a new violation for a design rule reason.

Returns: The newly created violation object.
Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

designRuleName	The Design Rule for which you want to create a new violation.
reason	The reason for which you want to create a new violation.
shortDescription	A short description of the violation displayed as the message on the Design Rule Violation dialog.
longDescription	A more detailed description of the violation displayed by the Full Violation Text button on the Design Rule Violation dialog.
objects	The objects in violation.

NXOpen::Routing::DesignRuleViolation* NXOpen::Routing::CustomManager::CreateViolationForReason	(	const char *	designRuleName,
		NXOpen::Routing::CustomManager::DesignRuleReason	reason,
		const char *	shortDescription,
		const char *	longDescription,
		const std::vector< NXOpen::NXObject * > &	objects
	)

Creates a new violation for a design rule reason.

Returns: The newly created violation object.
Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

designRuleName	The Design Rule for which you want to create a new violation.
reason	The reason for which you want to create a new violation.
shortDescription	A short description of the violation displayed as the message on the Design Rule Violation dialog.
longDescription	A more detailed description of the violation displayed by the Full Violation Text button on the Design Rule Violation dialog.
objects	The objects in violation.

void NXOpen::Routing::CustomManager::DeleteViolationsOfRuleOnObject	(	const NXString &	designRuleName,
		NXOpen::NXObject *	nxObject
	)

Finds the violation of a design rule attached to the given object and deletes it.

Useful when the given object no longer violates this rule. This method calls update after deleting the violations.
Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

designRuleName	The Design Rule for which you want to delete a violation.
nxObject	The object on which to delete the violation.

void NXOpen::Routing::CustomManager::DeleteViolationsOfRuleOnObject	(	const char *	designRuleName,
		NXOpen::NXObject *	nxObject
	)

Finds the violation of a design rule attached to the given object and deletes it.

Useful when the given object no longer violates this rule. This method calls update after deleting the violations.
Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

designRuleName	The Design Rule for which you want to delete a violation.
nxObject	The object on which to delete the violation.

void NXOpen::Routing::CustomManager::DeleteViolationsOnObjectForReason	(	NXOpen::Routing::CustomManager::DesignRuleReason	reason,
		NXOpen::NXObject *	nxObject
	)

Finds the violation of a design rule reason attached to the given object and deletes it.

Useful when the given object no longer violates this rule. This method calls update after deleting the violations.
Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

reason	The reason for which you want to delete a violation.
nxObject	The object on which to delete the violation.

void NXOpen::Routing::CustomManager::GetCallbacksRegisteredForReason	(	NXOpen::Routing::CustomManager::CallbackReason	reason,
		std::vector< int > &	registeredCallbackIds
	)

Returns the callbacks, if any, registered for the given reason.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

reason	The reason for which you want a list of callbacks.
registeredCallbackIds	The callback indentifiers, if any, registered with this reason.

void NXOpen::Routing::CustomManager::GetDesignRulesRegisteredForReason	(	NXOpen::Routing::CustomManager::DesignRuleReason	reason,
		std::vector< int > &	registeredDesignRuleIds
	)

Returns the design rules, if any, registered for the given reason.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

reason	The reason for which you want a list of design rules.
registeredDesignRuleIds	The design rule indentifiers, if any, registered with this reason.

std::vector<NXOpen::Routing::DesignRuleViolation *> NXOpen::Routing::CustomManager::GetViolationsForReason ( NXOpen::Routing::CustomManager::DesignRuleReason reason )

Returns any violations recorded against a design rule reason.

Returns: The violations for this reason.
Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

reason The reason for which you want a list of violations.

std::vector<NXOpen::Routing::DesignRuleViolation *> NXOpen::Routing::CustomManager::GetViolationsOfRule ( const NXString & designRuleName )

Returns any violations recorded against a design rule.

Returns: The violations for this reason.
Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

designRuleName The Design Rule for which you want a list of violations.

std::vector<NXOpen::Routing::DesignRuleViolation *> NXOpen::Routing::CustomManager::GetViolationsOfRule ( const char * designRuleName )

Returns any violations recorded against a design rule.

Returns: The violations for this reason.
Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

designRuleName The Design Rule for which you want a list of violations.

void NXOpen::Routing::CustomManager::RemoveAllCallbacks ( )

Removes all the registered callbacks, except those configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveAllCallbacksForReason ( NXOpen::Routing::CustomManager::CallbackReason reason )

Removes all the callbacks registered for a particular reason.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

reason The reason for which you want to remove all the callbacks.

void NXOpen::Routing::CustomManager::RemoveAllDesignRules ( )

Removes all the registered design rules, except those configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveAllDesignRulesForReason ( NXOpen::Routing::CustomManager::DesignRuleReason reason )

Removes all the design rules registered for a particular reason.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

reason The reason for which you want to remove all the design rules.

void NXOpen::Routing::CustomManager::RemoveAllPlugins ( )

Removes all the registered plugins, except those configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveAutoRoutePlugin ( )

Removes any registered autoroute plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveBomPlugin ( )

Removes any registered bill of materials plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveBundlePlugin ( )

Removes any registered bundle plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveCallback ( int callbackMethodId )

Removes the registered callback.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

callbackMethodId The callback identifier indicating which callback to remove.

void NXOpen::Routing::CustomManager::RemoveChoosePartPlugin ( )

Removes any registered choose part plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveCmpPostExportPlugin ( )

Removes any registered post-export CMP plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveCmpPreImportPlugin ( )

Removes any registered pre-import CMP plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveDesignRule ( int designRuleMethodId )

Removes the registered design rule.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

designRuleMethodId The design rule identifier indicating which design rule to remove.

void NXOpen::Routing::CustomManager::RemoveDisciplineChangedPlugin ( )

Removes any registered discpline changed plugin.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

void NXOpen::Routing::CustomManager::RemoveDuctSizeCalculatorCreateStockPlugin ( )

Removes any registered create stock plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

void NXOpen::Routing::CustomManager::RemoveDuctSizeCalculatorDisplayNotePlugin ( )

Removes any registered display note plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

void NXOpen::Routing::CustomManager::RemoveFilterBlankingPlugin ( )

Removes any registered filter blanking plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveHrnPostExportPlugin ( )

Removes any registered post-export HRN plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveHrnPreImportPlugin ( )

Removes any registered pre-import HRN plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveManualRoutePlugin ( )

Removes any registered manual route plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveNavigatorObjectSelectedPlugin ( )

Removes any registered navigator object selected plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemovePipingComponentFilePlugin ( )

Removes any registered piping component file plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_pipetube ("Routing Piping and Tubing")

void NXOpen::Routing::CustomManager::RemovePlmXmlPostExportPlugin ( )

Removes any registered post-export PLMXML plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemovePlmXmlPreImportPlugin ( )

Removes any registered pre-import PLMXML plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemovePlmXmlRouteNodeNamePlugin ( )

Removes any registered Route Node name plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemovePlmXmlRouteSectionNamePlugin ( )

Removes any registered Route Section name plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveSortConnectionsPlugin ( )

Removes any registered sort connections plugin.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveSpecificationChangedPlugin ( )

Removes any registered discpline changed plugin.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

void NXOpen::Routing::CustomManager::RemoveStockComponentLockedPlugin ( )

Removes any registered stock component locked plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveUnifyPathPlugin ( )

Removes any registered unify path plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveUnroutePlugin ( )

Removes any registered unroute plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::RemoveValidateFormboardPlugin ( )

Removes any registered validate formboard plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Routing::CustomManager::RemoveWrappedOverstockLengthCalculationPlugin ( )

Removes any registered wrapped overstock length calculation plugin, except one configured in the Application View (APV) file.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CustomManager::SetAutoRoutePlugin ( const NXOpen::Routing::CustomManager::AutoroutePlugin & autoRoutePlugin )

Sets the plugin Routing will instead of the internal automatic routing of connections along a path.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

autoRoutePlugin The method you want Routing to use instead of Routing's internal autoroute method.

void NXOpen::Routing::CustomManager::SetBomPlugin ( const NXOpen::Routing::CustomManager::BomPlugin & bomPlugin )

Sets the plugin called just after Routing creates a bill of materials.

The intent is that the plugin can then add stocks to Teamcenter's Product Structure.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

bomPlugin The method you want Routing to call after creating a bill of materials.

void NXOpen::Routing::CustomManager::SetBundlePlugin ( const NXOpen::Routing::CustomManager::BundlePlugin & bundlePlugin )

Sets the plugin Routing will call to determine the bundle diameter for each bundle in a harness.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

bundlePlugin The method you want Routing to call to determine the bundle diameters.

void NXOpen::Routing::CustomManager::SetChoosePartPlugin ( const NXOpen::Routing::CustomManager::ChoosePartPlugin & choosePartPlugin )

Sets the choose part plugin.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

choosePartPlugin The method you want Routing to use to choose a part to be placed.

void NXOpen::Routing::CustomManager::SetCmpPostExportPlugin ( const NXOpen::Routing::CustomManager::ImportExportPlugin & cmpPostExportPlugin )

Sets the plugin called just after Routing exports an CMP file.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

cmpPostExportPlugin The method you want Routing to call after exporting an CMP file.

void NXOpen::Routing::CustomManager::SetCmpPreImportPlugin ( const NXOpen::Routing::CustomManager::ImportExportPlugin & cmpPreImportPlugin )

Sets the plugin called before importing an CMP file.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

cmpPreImportPlugin The method you want Routing to call before importing an CMP file.

void NXOpen::Routing::CustomManager::SetDisciplineChangedPlugin ( const NXOpen::Routing::CustomManager::DisciplineChangedPlugin & disciplineChangedPlugin )

Sets the plugin Routing will use to display a note on the segments selected in the Duct Size Calculator.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

Parameters

disciplineChangedPlugin The method you want Routing to call when the user changes the discipline.

void NXOpen::Routing::CustomManager::SetDuctSizeCalculatorCreateStockPlugin ( const NXOpen::Routing::CustomManager::DuctSizeCalculatorCreateStockPlugin & createStockPlugin )

Sets the plugin Routing will use to create stock for the Duct Size Calculator command.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

Parameters

createStockPlugin The method you want Routing to use for the create stock plugin.

void NXOpen::Routing::CustomManager::SetDuctSizeCalculatorDisplayNotePlugin ( const NXOpen::Routing::CustomManager::DuctSizeCalculatorDisplayNotePlugin & displayNotePlugin )

Sets the plugin Routing will use to display a note on the segments selected in the Duct Size Calculator.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

Parameters

displayNotePlugin The method you want Routing to use to display the note.

void NXOpen::Routing::CustomManager::SetFilterBlankingPlugin ( const NXOpen::Routing::CustomManager::FilterBlankingPlugin & filterBlankingPlugin )

Sets the plugin called by Routing to determine if a segment or component needs to be blanked.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

filterBlankingPlugin The method you want Routing to call to determine if a segment or component should be blanked.

void NXOpen::Routing::CustomManager::SetHrnPostExportPlugin ( const NXOpen::Routing::CustomManager::ImportExportPlugin & hrnPostExportPlugin )

Sets the plugin called just after Routing exports an HRN file.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

hrnPostExportPlugin The method you want Routing to call after exporting an HRN file.

void NXOpen::Routing::CustomManager::SetHrnPreImportPlugin ( const NXOpen::Routing::CustomManager::ImportExportPlugin & hrnPreImportPlugin )

Sets the plugin called before importing an HRN file.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

hrnPreImportPlugin The method you want Routing to call before importing an HRN file.

void NXOpen::Routing::CustomManager::SetManualRoutePlugin ( const NXOpen::Routing::CustomManager::AutoroutePlugin & manualRoutePlugin )

Sets the plugin Routing will instead of the internal manual routing of connections along a path.

This uses the same plugin prototype as the autoroute plugin. Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

manualRoutePlugin The method you want Routing to use instead of Routing's internal manual route method.

void NXOpen::Routing::CustomManager::SetNavigatorObjectSelectedPlugin ( const NXOpen::Routing::CustomManager::NavigatorObjectSelectedPlugin & navigatorObjectSelectedPlugin )

Sets the plugin Routing will call whenever an object on the Component or Connection Navigator is selected or deselected.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

navigatorObjectSelectedPlugin The method you want Routing to use instead of Routing's internal manual route method.

void NXOpen::Routing::CustomManager::SetPipingComponentFilePlugin ( const NXOpen::Routing::CustomManager::PipingComponentFilePlugin & pipingComponentFilePlugin )

Sets the plugin Routing will use for the Unify Path command.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_pipetube ("Routing Piping and Tubing")

Parameters

pipingComponentFilePlugin The method you want Routing to use for the piping component file plugin.

void NXOpen::Routing::CustomManager::SetPlmXmlPostExportPlugin ( const NXOpen::Routing::CustomManager::ImportExportPlugin & plmXmlPostExportPlugin )

Sets the plugin called just after Routing exports an PLMXML file.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

plmXmlPostExportPlugin The method you want Routing to call after exporting an PLMXML file.

void NXOpen::Routing::CustomManager::SetPlmXmlPreImportPlugin ( const NXOpen::Routing::CustomManager::ImportExportPlugin & plmXmlPreImportPlugin )

Sets the plugin called before importing an PLMXML file.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

plmXmlPreImportPlugin The method you want Routing to call before importing an PLMXML file.

void NXOpen::Routing::CustomManager::SetPlmXmlRouteNodeNamePlugin ( const NXOpen::Routing::CustomManager::PlmxmlObjectNamePlugin & plmXmlRouteNodeNamePlugin )

Sets the plugin Routing will call to get the name of the next Route Node for the PLMXML file.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

plmXmlRouteNodeNamePlugin The method you want Routing to call to get the name of the next Route Node.

void NXOpen::Routing::CustomManager::SetPlmXmlRouteSectionNamePlugin ( const NXOpen::Routing::CustomManager::PlmxmlObjectNamePlugin & plmXmlRouteSectionNamePlugin )

Sets the plugin Routing will call to get the name of the next Route Section for the PLMXML file.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

plmXmlRouteSectionNamePlugin The method you want Routing to call to get the name of the next Route Section.

void NXOpen::Routing::CustomManager::SetSortConnectionsPlugin ( const NXOpen::Routing::CustomManager::SortConnectionsPlugin & sortConnectionsPlugin )

Sets the plugin Routing will call to sort the connections about to be routed.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

sortConnectionsPlugin The method you want Routing to use to sort the connections.

void NXOpen::Routing::CustomManager::SetSpecificationChangedPlugin ( const NXOpen::Routing::CustomManager::SpecificationChangedPlugin & specificationChangedPlugin )

Sets the plugin Routing will use to display a note on the segments selected in the Duct Size Calculator.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_hvac ("Routing HVAC")

Parameters

specificationChangedPlugin The method you want Routing to call when the user changes the specification.

void NXOpen::Routing::CustomManager::SetStockComponentLockedPlugin ( const NXOpen::Routing::CustomManager::StockComponentLockedPlugin & stockComponentLockedPlugin )

Sets the plugin Routing will call to see if a stock component is modifiable.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockComponentLockedPlugin The method you want Routing to call to see if a stock component is modifiable.

void NXOpen::Routing::CustomManager::SetUnifyPathPlugin ( const NXOpen::Routing::CustomManager::UnifyPathPlugin & unifyPathPlugin )

Sets the plugin Routing will use for the Unify Path command.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

unifyPathPlugin The method you want Routing to use for the Unify Path command.

void NXOpen::Routing::CustomManager::SetUnroutePlugin ( const NXOpen::Routing::CustomManager::AutoroutePlugin & unroutePlugin )

Sets the plugin Routing will instead of the internal unroute method.

This uses the same plugin prototype as the autoroute plugin. Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

unroutePlugin The method you want Routing to use instead of Routing's internal unroute method.

void NXOpen::Routing::CustomManager::SetValidateFormboardPlugin ( const NXOpen::Routing::CustomManager::ValidateFormboardPlugin & validateFormboardPlugin )

Sets the plugin Routing will call to validate the harnesses on a formboard.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_harness ("Routing Harness")

Parameters

validateFormboardPlugin The method you want Routing to call to validate the formboard harnesses.

void NXOpen::Routing::CustomManager::SetWrappedOverstockLengthCalculationPlugin ( const NXOpen::Routing::CustomManager::WrappedOverstockLengthCalculationPlugin & lengthCalculationPlugin )

Sets the plugin called by Routing to calculate the length of a wrapped overstock.

Will throw an error if one is already registered.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

lengthCalculationPlugin The method you want Routing to call to calculate the length of a wrapped overstock.

tag_t NXOpen::Routing::CustomManager::Tag ( ) const

Returns the tag of this object.

The documentation for this class was generated from the following file:

Routing_CustomManager.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation