CustomManager Class¶

class NXOpen.Routing.CustomManager¶

Bases: object

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

New in version NX12.0.0.

Methods¶

Method	Description
AddCallback	Adds the callback with the given reason.
AddDesignRule	Adds the design rule with the given reason.
CreateViolationForReason	Creates a new violation for a design rule reason.
DeleteViolationsOfRuleOnObject	Finds the violation of a design rule attached to the given object and deletes it.
DeleteViolationsOnObjectForReason	Finds the violation of a design rule reason attached to the given object and deletes it.
GetCallbacksRegisteredForReason	Returns the callbacks, if any, registered for the given reason.
GetDesignRulesRegisteredForReason	Returns the design rules, if any, registered for the given reason.
GetViolationsForReason	Returns any violations recorded against a design rule reason.
GetViolationsOfRule	Returns any violations recorded against a design rule.
RemoveAllCallbacks	Removes all the registered callbacks, except those configured in the Application View (APV) file.
RemoveAllCallbacksForReason	Removes all the callbacks registered for a particular reason.
RemoveAllDesignRules	Removes all the registered design rules, except those configured in the Application View (APV) file.
RemoveAllDesignRulesForReason	Removes all the design rules registered for a particular reason.
RemoveAllPlugins	Removes all the registered plugins, except those configured in the Application View (APV) file.
RemoveAutoRoutePlugin	Removes any registered autoroute plugin, except one configured in the Application View (APV) file.
RemoveBomPlugin	Removes any registered bill of materials plugin, except one configured in the Application View (APV) file.
RemoveBundlePlugin	Removes any registered bundle plugin, except one configured in the Application View (APV) file.
RemoveCallback	Removes the registered callback.
RemoveChoosePartPlugin	Removes any registered choose part plugin, except one configured in the Application View (APV) file.
RemoveCmpPostExportPlugin	Removes any registered post-export CMP plugin, except one configured in the Application View (APV) file.
RemoveCmpPreImportPlugin	Removes any registered pre-import CMP plugin, except one configured in the Application View (APV) file.
RemoveDesignRule	Removes the registered design rule.
RemoveDisciplineChangedPlugin	Removes any registered discpline changed plugin.
RemoveDuctSizeCalculatorCreateStockPlugin	Removes any registered create stock plugin, except one configured in the Application View (APV) file.
RemoveDuctSizeCalculatorDisplayNotePlugin	Removes any registered display note plugin, except one configured in the Application View (APV) file.
RemoveFilterBlankingPlugin	Removes any registered filter blanking plugin, except one configured in the Application View (APV) file.
RemoveHrnPostExportPlugin	Removes any registered post-export HRN plugin, except one configured in the Application View (APV) file.
RemoveHrnPreImportPlugin	Removes any registered pre-import HRN plugin, except one configured in the Application View (APV) file.
RemoveManualRoutePlugin	Removes any registered manual route plugin, except one configured in the Application View (APV) file.
RemoveNavigatorObjectSelectedPlugin	Removes any registered navigator object selected plugin, except one configured in the Application View (APV) file.
RemovePipingComponentFilePlugin	Removes any registered piping component file plugin, except one configured in the Application View (APV) file.
RemovePlmXmlPostExportPlugin	Removes any registered post-export PLMXML plugin, except one configured in the Application View (APV) file.
RemovePlmXmlPreImportPlugin	Removes any registered pre-import PLMXML plugin, except one configured in the Application View (APV) file.
RemovePlmXmlRouteNodeNamePlugin	Removes any registered Route Node name plugin, except one configured in the Application View (APV) file.
RemovePlmXmlRouteSectionNamePlugin	Removes any registered Route Section name plugin, except one configured in the Application View (APV) file.
RemoveSortConnectionsPlugin	Removes any registered sort connections plugin.
RemoveSpecificationChangedPlugin	Removes any registered discpline changed plugin.
RemoveStockComponentLockedPlugin	Removes any registered stock component locked plugin, except one configured in the Application View (APV) file.
RemoveUnifyPathPlugin	Removes any registered unify path plugin, except one configured in the Application View (APV) file.
RemoveUnroutePlugin	Removes any registered unroute plugin, except one configured in the Application View (APV) file.
RemoveValidateFormboardPlugin	Removes any registered validate formboard plugin, except one configured in the Application View (APV) file.
RemoveWrappedOverstockLengthCalculationPlugin	Removes any registered wrapped overstock length calculation plugin, except one configured in the Application View (APV) file.
SetAutoRoutePlugin	Sets the plugin Routing will instead of the internal automatic routing of connections along a path.
SetBomPlugin	Sets the plugin called just after Routing creates a bill of materials.
SetBundlePlugin	Sets the plugin Routing will call to determine the bundle diameter for each bundle in a harness.
SetChoosePartPlugin	Sets the choose part plugin.
SetCmpPostExportPlugin	Sets the plugin called just after Routing exports an CMP file.
SetCmpPreImportPlugin	Sets the plugin called before importing an CMP file.
SetDisciplineChangedPlugin	Sets the plugin Routing will use to display a note on the segments selected in the Duct Size Calculator.
SetDuctSizeCalculatorCreateStockPlugin	Sets the plugin Routing will use to create stock for the Duct Size Calculator command.
SetDuctSizeCalculatorDisplayNotePlugin	Sets the plugin Routing will use to display a note on the segments selected in the Duct Size Calculator.
SetFilterBlankingPlugin	Sets the plugin called by Routing to determine if a segment or component needs to be blanked.
SetHrnPostExportPlugin	Sets the plugin called just after Routing exports an HRN file.
SetHrnPreImportPlugin	Sets the plugin called before importing an HRN file.
SetManualRoutePlugin	Sets the plugin Routing will instead of the internal manual routing of connections along a path.
SetNavigatorObjectSelectedPlugin	Sets the plugin Routing will call whenever an object on the Component or Connection Navigator is selected or deselected.
SetPipingComponentFilePlugin	Sets the plugin Routing will use for the Unify Path command.
SetPlmXmlPostExportPlugin	Sets the plugin called just after Routing exports an PLMXML file.
SetPlmXmlPreImportPlugin	Sets the plugin called before importing an PLMXML file.
SetPlmXmlRouteNodeNamePlugin	Sets the plugin Routing will call to get the name of the next Route Node for the PLMXML file.
SetPlmXmlRouteSectionNamePlugin	Sets the plugin Routing will call to get the name of the next Route Section for the PLMXML file.
SetSortConnectionsPlugin	Sets the plugin Routing will call to sort the connections about to be routed.
SetSpecificationChangedPlugin	Sets the plugin Routing will use to display a note on the segments selected in the Duct Size Calculator.
SetStockComponentLockedPlugin	Sets the plugin Routing will call to see if a stock component is modifiable.
SetUnifyPathPlugin	Sets the plugin Routing will use for the Unify Path command.
SetUnroutePlugin	Sets the plugin Routing will instead of the internal unroute method.
SetValidateFormboardPlugin	Sets the plugin Routing will call to validate the harnesses on a formboard.
SetWrappedOverstockLengthCalculationPlugin	Sets the plugin called by Routing to calculate the length of a wrapped overstock.

Enumerations¶

CustomManagerCallbackReason Enumeration	The reason for registering a callback indicates which Routing commands will use the callback.
CustomManagerDesignRuleReason Enumeration	The reason for registering a design rule indicates which Routing commands will use the design rule.
CustomManagerDuctSizeCalculatorDisplayNoteFlag Enumeration	Used by the Duct Size Calculator’s display note plugin to indicate whether to add or remove the note.
CustomManagerDuctSizeCalculatorDuctShape Enumeration	Used by the Duct Size Calculator’s create stock plugin to indicate what shape stock to create.
CustomManagerNavigatorType Enumeration	Used by the navigator object selected plugin to indicate in which navigator the objects were selected.
CustomManagerPipingComponentFileOptions Enumeration	Used by the piping component file plugin to indicate if it should overwrite an existing file or not.
CustomManagerSelectionType Enumeration	Used by the navigator object selected plugin to indicate whether the objects are selected or deselected.

Method Detail¶

AddCallback¶

CustomManager.AddCallback¶

Adds the callback with the given reason.

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

Signature AddCallback(reason, callbackMethod)

Parameters:	reason (`NXOpen.Routing.CustomManagerCallbackReason`) – The reason for which you want this callback called. callbackMethod (CallableObject) – The method you want to be called.
Returns:	A unique identifier for your callback.
Return type:	int

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

AddDesignRule¶

CustomManager.AddDesignRule¶

Adds the design rule with the given reason.

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

Signature AddDesignRule(reason, name, description, designRuleMethod)

Parameters:	reason (`NXOpen.Routing.CustomManagerDesignRuleReason`) – The reason for which you want this design rule called. name (str) – A descriptive name for this design rule. description (str) – A detailed description of what this design rule checks. designRuleMethod (CallableObject) – The method you want to be called.
Returns:	A unique identifier for your design rule.
Return type:	int

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

CreateViolationForReason¶

CustomManager.CreateViolationForReason¶

Creates a new violation for a design rule reason.

Signature CreateViolationForReason(designRuleName, reason, shortDescription, longDescription, objects)

Parameters:	designRuleName (str) – The Design Rule for which you want to create a new violation. reason (`NXOpen.Routing.CustomManagerDesignRuleReason`) – The reason for which you want to create a new violation. shortDescription (str) – A short description of the violation displayed as the message on the Design Rule Violation dialog. longDescription (str) – A more detailed description of the violation displayed by the Full Violation Text button on the Design Rule Violation dialog. objects (list of `NXOpen.NXObject`) – The objects in violation.
Returns:	The newly created violation object.
Return type:	`NXOpen.Routing.DesignRuleViolation`

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

DeleteViolationsOfRuleOnObject¶

CustomManager.DeleteViolationsOfRuleOnObject¶

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.

Signature DeleteViolationsOfRuleOnObject(designRuleName, nxObject)

Parameters:	designRuleName (str) – The Design Rule for which you want to delete a violation. nxObject (`NXOpen.NXObject`) – The object on which to delete the violation.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

DeleteViolationsOnObjectForReason¶

CustomManager.DeleteViolationsOnObjectForReason¶

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.

Signature DeleteViolationsOnObjectForReason(reason, nxObject)

Parameters:	reason (`NXOpen.Routing.CustomManagerDesignRuleReason`) – The reason for which you want to delete a violation. nxObject (`NXOpen.NXObject`) – The object on which to delete the violation.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetCallbacksRegisteredForReason¶

CustomManager.GetCallbacksRegisteredForReason¶

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

Signature GetCallbacksRegisteredForReason(reason)

Parameters:	reason (`NXOpen.Routing.CustomManagerCallbackReason`) – The reason for which you want a list of callbacks.
Returns:	The callback indentifiers, if any, registered with this reason.
Return type:	list of int

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

GetDesignRulesRegisteredForReason¶

CustomManager.GetDesignRulesRegisteredForReason¶

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

Signature GetDesignRulesRegisteredForReason(reason)

Parameters:	reason (`NXOpen.Routing.CustomManagerDesignRuleReason`) – The reason for which you want a list of design rules.
Returns:	The design rule indentifiers, if any, registered with this reason.
Return type:	list of int

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetViolationsForReason¶

CustomManager.GetViolationsForReason¶

Returns any violations recorded against a design rule reason.

Signature GetViolationsForReason(reason)

Parameters:	reason (`NXOpen.Routing.CustomManagerDesignRuleReason`) – The reason for which you want a list of violations.
Returns:	The violations for this reason.
Return type:	list of `NXOpen.Routing.DesignRuleViolation`

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetViolationsOfRule¶

CustomManager.GetViolationsOfRule¶

Returns any violations recorded against a design rule.

Signature GetViolationsOfRule(designRuleName)

Parameters:	designRuleName (str) – The Design Rule for which you want a list of violations.
Returns:	The violations for this reason.
Return type:	list of `NXOpen.Routing.DesignRuleViolation`

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveAllCallbacks¶

CustomManager.RemoveAllCallbacks¶

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

Signature RemoveAllCallbacks()

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

RemoveAllCallbacksForReason¶

CustomManager.RemoveAllCallbacksForReason¶

Removes all the callbacks registered for a particular reason.

Signature RemoveAllCallbacksForReason(reason)

Parameters:	reason (`NXOpen.Routing.CustomManagerCallbackReason`) – The reason for which you want to remove all the callbacks.

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

RemoveAllDesignRules¶

CustomManager.RemoveAllDesignRules¶

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

Signature RemoveAllDesignRules()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveAllDesignRulesForReason¶

CustomManager.RemoveAllDesignRulesForReason¶

Removes all the design rules registered for a particular reason.

Signature RemoveAllDesignRulesForReason(reason)

Parameters:	reason (`NXOpen.Routing.CustomManagerDesignRuleReason`) – The reason for which you want to remove all the design rules.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveAllPlugins¶

CustomManager.RemoveAllPlugins¶

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

Signature RemoveAllPlugins()

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

RemoveAutoRoutePlugin¶

CustomManager.RemoveAutoRoutePlugin¶

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

Signature RemoveAutoRoutePlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveBomPlugin¶

CustomManager.RemoveBomPlugin¶

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

Signature RemoveBomPlugin()

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

RemoveBundlePlugin¶

CustomManager.RemoveBundlePlugin¶

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

Signature RemoveBundlePlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveCallback¶

CustomManager.RemoveCallback¶

Removes the registered callback.

Signature RemoveCallback(callbackMethodId)

Parameters:	callbackMethodId (int) – The callback identifier indicating which callback to remove.

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

RemoveChoosePartPlugin¶

CustomManager.RemoveChoosePartPlugin¶

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

Signature RemoveChoosePartPlugin()

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

RemoveCmpPostExportPlugin¶

CustomManager.RemoveCmpPostExportPlugin¶

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

Signature RemoveCmpPostExportPlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveCmpPreImportPlugin¶

CustomManager.RemoveCmpPreImportPlugin¶

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

Signature RemoveCmpPreImportPlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveDesignRule¶

CustomManager.RemoveDesignRule¶

Removes the registered design rule.

Signature RemoveDesignRule(designRuleMethodId)

Parameters:	designRuleMethodId (int) – The design rule identifier indicating which design rule to remove.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveDisciplineChangedPlugin¶

CustomManager.RemoveDisciplineChangedPlugin¶

Removes any registered discpline changed plugin.

Signature RemoveDisciplineChangedPlugin()

New in version NX12.0.0.

License requirements: routing_hvac (“Routing HVAC”)

RemoveDuctSizeCalculatorCreateStockPlugin¶

CustomManager.RemoveDuctSizeCalculatorCreateStockPlugin¶

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

Signature RemoveDuctSizeCalculatorCreateStockPlugin()

New in version NX12.0.0.

License requirements: routing_hvac (“Routing HVAC”)

RemoveDuctSizeCalculatorDisplayNotePlugin¶

CustomManager.RemoveDuctSizeCalculatorDisplayNotePlugin¶

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

Signature RemoveDuctSizeCalculatorDisplayNotePlugin()

New in version NX12.0.0.

License requirements: routing_hvac (“Routing HVAC”)

RemoveFilterBlankingPlugin¶

CustomManager.RemoveFilterBlankingPlugin¶

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

Signature RemoveFilterBlankingPlugin()

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

RemoveHrnPostExportPlugin¶

CustomManager.RemoveHrnPostExportPlugin¶

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

Signature RemoveHrnPostExportPlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveHrnPreImportPlugin¶

CustomManager.RemoveHrnPreImportPlugin¶

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

Signature RemoveHrnPreImportPlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveManualRoutePlugin¶

CustomManager.RemoveManualRoutePlugin¶

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

Signature RemoveManualRoutePlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveNavigatorObjectSelectedPlugin¶

CustomManager.RemoveNavigatorObjectSelectedPlugin¶

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

Signature RemoveNavigatorObjectSelectedPlugin()

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

RemovePipingComponentFilePlugin¶

CustomManager.RemovePipingComponentFilePlugin¶

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

Signature RemovePipingComponentFilePlugin()

New in version NX12.0.0.

License requirements: routing_pipetube (“Routing Piping and Tubing”)

RemovePlmXmlPostExportPlugin¶

CustomManager.RemovePlmXmlPostExportPlugin¶

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

Signature RemovePlmXmlPostExportPlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemovePlmXmlPreImportPlugin¶

CustomManager.RemovePlmXmlPreImportPlugin¶

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

Signature RemovePlmXmlPreImportPlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemovePlmXmlRouteNodeNamePlugin¶

CustomManager.RemovePlmXmlRouteNodeNamePlugin¶

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

Signature RemovePlmXmlRouteNodeNamePlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemovePlmXmlRouteSectionNamePlugin¶

CustomManager.RemovePlmXmlRouteSectionNamePlugin¶

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

Signature RemovePlmXmlRouteSectionNamePlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveSortConnectionsPlugin¶

CustomManager.RemoveSortConnectionsPlugin¶

Removes any registered sort connections plugin.

Signature RemoveSortConnectionsPlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveSpecificationChangedPlugin¶

CustomManager.RemoveSpecificationChangedPlugin¶

Removes any registered discpline changed plugin.

Signature RemoveSpecificationChangedPlugin()

New in version NX12.0.0.

License requirements: routing_hvac (“Routing HVAC”)

RemoveStockComponentLockedPlugin¶

CustomManager.RemoveStockComponentLockedPlugin¶

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

Signature RemoveStockComponentLockedPlugin()

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

RemoveUnifyPathPlugin¶

CustomManager.RemoveUnifyPathPlugin¶

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

Signature RemoveUnifyPathPlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveUnroutePlugin¶

CustomManager.RemoveUnroutePlugin¶

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

Signature RemoveUnroutePlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RemoveValidateFormboardPlugin¶

CustomManager.RemoveValidateFormboardPlugin¶

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

Signature RemoveValidateFormboardPlugin()

New in version NX12.0.0.

License requirements: routing_harness (“Routing Harness”)

RemoveWrappedOverstockLengthCalculationPlugin¶

CustomManager.RemoveWrappedOverstockLengthCalculationPlugin¶

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

Signature RemoveWrappedOverstockLengthCalculationPlugin()

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetAutoRoutePlugin¶

CustomManager.SetAutoRoutePlugin¶

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.

Signature SetAutoRoutePlugin(autoRoutePlugin)

Parameters:	autoRoutePlugin (CallableObject) – The method you want Routing to use instead of Routing’s internal autoroute method.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetBomPlugin¶

CustomManager.SetBomPlugin¶

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.

Signature SetBomPlugin(bomPlugin)

Parameters:	bomPlugin (CallableObject) – The method you want Routing to call after creating a bill of materials.

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

SetBundlePlugin¶

CustomManager.SetBundlePlugin¶

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.

Signature SetBundlePlugin(bundlePlugin)

Parameters:	bundlePlugin (CallableObject) – The method you want Routing to call to determine the bundle diameters.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetChoosePartPlugin¶

CustomManager.SetChoosePartPlugin¶

Sets the choose part plugin.

Will throw an error if one is already registered.

Signature SetChoosePartPlugin(choosePartPlugin)

Parameters:	choosePartPlugin (CallableObject) – The method you want Routing to use to choose a part to be placed.

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

SetCmpPostExportPlugin¶

CustomManager.SetCmpPostExportPlugin¶

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

Will throw an error if one is already registered.

Signature SetCmpPostExportPlugin(cmpPostExportPlugin)

Parameters:	cmpPostExportPlugin (CallableObject) – The method you want Routing to call after exporting an CMP file.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetCmpPreImportPlugin¶

CustomManager.SetCmpPreImportPlugin¶

Sets the plugin called before importing an CMP file.

Will throw an error if one is already registered.

Signature SetCmpPreImportPlugin(cmpPreImportPlugin)

Parameters:	cmpPreImportPlugin (CallableObject) – The method you want Routing to call before importing an CMP file.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetDisciplineChangedPlugin¶

CustomManager.SetDisciplineChangedPlugin¶

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.

Signature SetDisciplineChangedPlugin(disciplineChangedPlugin)

Parameters:	disciplineChangedPlugin (CallableObject) – The method you want Routing to call when the user changes the discipline.

New in version NX12.0.0.

License requirements: routing_hvac (“Routing HVAC”)

SetDuctSizeCalculatorCreateStockPlugin¶

CustomManager.SetDuctSizeCalculatorCreateStockPlugin¶

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

Will throw an error if one is already registered.

Signature SetDuctSizeCalculatorCreateStockPlugin(createStockPlugin)

Parameters:	createStockPlugin (CallableObject) – The method you want Routing to use for the create stock plugin.

New in version NX12.0.0.

License requirements: routing_hvac (“Routing HVAC”)

SetDuctSizeCalculatorDisplayNotePlugin¶

CustomManager.SetDuctSizeCalculatorDisplayNotePlugin¶

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.

Signature SetDuctSizeCalculatorDisplayNotePlugin(displayNotePlugin)

Parameters:	displayNotePlugin (CallableObject) – The method you want Routing to use to display the note.

New in version NX12.0.0.

License requirements: routing_hvac (“Routing HVAC”)

SetFilterBlankingPlugin¶

CustomManager.SetFilterBlankingPlugin¶

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.

Signature SetFilterBlankingPlugin(filterBlankingPlugin)

Parameters:	filterBlankingPlugin (CallableObject) – The method you want Routing to call to determine if a segment or component should be blanked.

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

SetHrnPostExportPlugin¶

CustomManager.SetHrnPostExportPlugin¶

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

Will throw an error if one is already registered.

Signature SetHrnPostExportPlugin(hrnPostExportPlugin)

Parameters:	hrnPostExportPlugin (CallableObject) – The method you want Routing to call after exporting an HRN file.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetHrnPreImportPlugin¶

CustomManager.SetHrnPreImportPlugin¶

Sets the plugin called before importing an HRN file.

Will throw an error if one is already registered.

Signature SetHrnPreImportPlugin(hrnPreImportPlugin)

Parameters:	hrnPreImportPlugin (CallableObject) – The method you want Routing to call before importing an HRN file.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetManualRoutePlugin¶

CustomManager.SetManualRoutePlugin¶

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.

Signature SetManualRoutePlugin(manualRoutePlugin)

Parameters:	manualRoutePlugin (CallableObject) – The method you want Routing to use instead of Routing’s internal manual route method.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetNavigatorObjectSelectedPlugin¶

CustomManager.SetNavigatorObjectSelectedPlugin¶

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.

Signature SetNavigatorObjectSelectedPlugin(navigatorObjectSelectedPlugin)

Parameters:	navigatorObjectSelectedPlugin (CallableObject) – The method you want Routing to use instead of Routing’s internal manual route method.

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

SetPipingComponentFilePlugin¶

CustomManager.SetPipingComponentFilePlugin¶

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

Will throw an error if one is already registered.

Signature SetPipingComponentFilePlugin(pipingComponentFilePlugin)

Parameters:	pipingComponentFilePlugin (CallableObject) – The method you want Routing to use for the piping component file plugin.

New in version NX12.0.0.

License requirements: routing_pipetube (“Routing Piping and Tubing”)

SetPlmXmlPostExportPlugin¶

CustomManager.SetPlmXmlPostExportPlugin¶

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

Will throw an error if one is already registered.

Signature SetPlmXmlPostExportPlugin(plmXmlPostExportPlugin)

Parameters:	plmXmlPostExportPlugin (CallableObject) – The method you want Routing to call after exporting an PLMXML file.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetPlmXmlPreImportPlugin¶

CustomManager.SetPlmXmlPreImportPlugin¶

Sets the plugin called before importing an PLMXML file.

Will throw an error if one is already registered.

Signature SetPlmXmlPreImportPlugin(plmXmlPreImportPlugin)

Parameters:	plmXmlPreImportPlugin (CallableObject) – The method you want Routing to call before importing an PLMXML file.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetPlmXmlRouteNodeNamePlugin¶

CustomManager.SetPlmXmlRouteNodeNamePlugin¶

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.

Signature SetPlmXmlRouteNodeNamePlugin(plmXmlRouteNodeNamePlugin)

Parameters:	plmXmlRouteNodeNamePlugin (CallableObject) – The method you want Routing to call to get the name of the next Route Node.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetPlmXmlRouteSectionNamePlugin¶

CustomManager.SetPlmXmlRouteSectionNamePlugin¶

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.

Signature SetPlmXmlRouteSectionNamePlugin(plmXmlRouteSectionNamePlugin)

Parameters:	plmXmlRouteSectionNamePlugin (CallableObject) – The method you want Routing to call to get the name of the next Route Section.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetSortConnectionsPlugin¶

CustomManager.SetSortConnectionsPlugin¶

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

Will throw an error if one is already registered.

Signature SetSortConnectionsPlugin(sortConnectionsPlugin)

Parameters:	sortConnectionsPlugin (CallableObject) – The method you want Routing to use to sort the connections.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetSpecificationChangedPlugin¶

CustomManager.SetSpecificationChangedPlugin¶

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.

Signature SetSpecificationChangedPlugin(specificationChangedPlugin)

Parameters:	specificationChangedPlugin (CallableObject) – The method you want Routing to call when the user changes the specification.

New in version NX12.0.0.

License requirements: routing_hvac (“Routing HVAC”)

SetStockComponentLockedPlugin¶

CustomManager.SetStockComponentLockedPlugin¶

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

Will throw an error if one is already registered.

Signature SetStockComponentLockedPlugin(stockComponentLockedPlugin)

Parameters:	stockComponentLockedPlugin (CallableObject) – The method you want Routing to call to see if a stock component is modifiable.

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

SetUnifyPathPlugin¶

CustomManager.SetUnifyPathPlugin¶

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

Will throw an error if one is already registered.

Signature SetUnifyPathPlugin(unifyPathPlugin)

Parameters:	unifyPathPlugin (CallableObject) – The method you want Routing to use for the Unify Path command.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetUnroutePlugin¶

CustomManager.SetUnroutePlugin¶

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.

Signature SetUnroutePlugin(unroutePlugin)

Parameters:	unroutePlugin (CallableObject) – The method you want Routing to use instead of Routing’s internal unroute method.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetValidateFormboardPlugin¶

CustomManager.SetValidateFormboardPlugin¶

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

Will throw an error if one is already registered.

Signature SetValidateFormboardPlugin(validateFormboardPlugin)

Parameters:	validateFormboardPlugin (CallableObject) – The method you want Routing to call to validate the formboard harnesses.

New in version NX12.0.0.

License requirements: routing_harness (“Routing Harness”)

SetWrappedOverstockLengthCalculationPlugin¶

CustomManager.SetWrappedOverstockLengthCalculationPlugin¶

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

Will throw an error if one is already registered.

Signature SetWrappedOverstockLengthCalculationPlugin(lengthCalculationPlugin)

Parameters:	lengthCalculationPlugin (CallableObject) – The method you want Routing to call to calculate the length of a wrapped overstock.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)