LogicalDesignService Class

class NXOpen.MechanicalRouting.LogicalDesignService

Bases: object

Represents a NXOpen.MechanicalRouting.LogicalDesignService object.

Uses the MechanicalRouting.RoutingManager.LogicalDesignService() to obtain an instance of this class.

To obtain an instance of this class, refer to NXOpen.MechanicalRouting.RoutingManager

New in version NX11.0.0.

Methods

Method Description
Assign3DPortToLogicalPort Assigns a 3D Routing.Port mapping to a logical port object.
AssignComponentToLogicalEquipment Assigns a component Assemblies.Component to a logical equipment object.
AssignComponentsToLogicalConnection Assigns a list of Assemblies.Component mapping to a logical connection object.
DeleteRuns Deletes run objects.
EnsureLogicalModelIsLoaded Ensures that the logical model is loaded for all the Runs included in the given Assemblies.Component that represents a container for the Routing design, such as a subset in a workset
GetActiveRun Gets a NXOpen.PLAS.Run that is currently active in given Assemblies.Component that represents a container for the Routing design, such as a subset in a workset
GetMappingStatus Returns the mapping status from the logical design to physical design.
GetMappingStatusMessage Returns the mapping status message from logical design to physical design.
GetRunsInContainer Gets the NXOpen.PLAS.Run`s that are included in a given :py:class:`Assemblies.Component that represents a container for the Routing design, such as a subset in a workset
IsRunIncludedInSubset Returns true if the supplied NXOpen.PLAS.Run is included in given Assemblies.Component that represents a container for the Routing design, such as a subset in Workset
LoadAllComponents Adds a NXOpen.PLAS.Run in Assemblies.Subset which is currently set as work part.
MakeRunActive Makes a NXOpen.PLAS.Run active in given Assemblies.Component that represents a container for the Routing design, such as a subset in Workset
ReassignComponentsFromLogicalConnection Reassigns all the components from a source logical connection object to a destination logical connection object or run object.
ReassignComponentsToRun Reassigns a list of Assemblies.Component mapping to a destination run object.
Unassign3DPortsFromLogicalPort Unassigns the 3D ports from the logical port object.
UnassignComponentToLogicalEquipment Unassigns all the components that are currently assigned to the given logical equipment object.
UnassignComponentsToLogicalConnection Unassigns all the components currently assigned to this logical connection object.

Enumerations

LogicalDesignServiceMappingStatus Enumeration The status returned from checking the logical design mapping to physical design.

Method Detail

Assign3DPortToLogicalPort

LogicalDesignService.Assign3DPortToLogicalPort

Assigns a 3D Routing.Port mapping to a logical port object.

Signature Assign3DPortToLogicalPort(logicalPort, physicalPort)

Parameters:

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

AssignComponentToLogicalEquipment

LogicalDesignService.AssignComponentToLogicalEquipment

Assigns a component Assemblies.Component to a logical equipment object.

Signature AssignComponentToLogicalEquipment(logicalEquipment, component)

Parameters:

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

AssignComponentsToLogicalConnection

LogicalDesignService.AssignComponentsToLogicalConnection

Assigns a list of Assemblies.Component mapping to a logical connection object.

Signature AssignComponentsToLogicalConnection(components, logicalConnection)

Parameters:

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

DeleteRuns

LogicalDesignService.DeleteRuns

Deletes run objects.

NOTE: only the empty run object can be deleted.

Signature DeleteRuns(runs)

Parameters:runs (list of NXOpen.NXObject) – The run objects.

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

EnsureLogicalModelIsLoaded

LogicalDesignService.EnsureLogicalModelIsLoaded

Ensures that the logical model is loaded for all the Runs included in the given Assemblies.Component that represents a container for the Routing design, such as a subset in a workset

Signature EnsureLogicalModelIsLoaded(container)

Parameters:container (NXOpen.Assemblies.Component) – A component that represents the container that holds the Routing design such as a subset in a workset

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

GetActiveRun

LogicalDesignService.GetActiveRun

Gets a NXOpen.PLAS.Run that is currently active in given Assemblies.Component that represents a container for the Routing design, such as a subset in a workset

Signature GetActiveRun(container)

Parameters:container (NXOpen.Assemblies.Component) – A component that represents the container that holds the Routing design such as a subset in a workset
Returns:The currently active Run.

Can be null if no active Run is present :rtype: NXOpen.NXObject

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

GetMappingStatus

LogicalDesignService.GetMappingStatus

Returns the mapping status from the logical design to physical design.

Signature GetMappingStatus(routingObject, container)

Parameters:
Returns:
Return type:

NXOpen.MechanicalRouting.LogicalDesignServiceMappingStatus

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

GetMappingStatusMessage

LogicalDesignService.GetMappingStatusMessage

Returns the mapping status message from logical design to physical design.

Signature GetMappingStatusMessage(routingObject, container)

Parameters:
Returns:
Return type:

str

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

GetRunsInContainer

LogicalDesignService.GetRunsInContainer

Gets the NXOpen.PLAS.Run`s that are included in a given :py:class:`Assemblies.Component that represents a container for the Routing design, such as a subset in a workset

Signature GetRunsInContainer(container)

Parameters:container (NXOpen.Assemblies.Component) – A component that represents the container that holds the Routing design, such as a subset in a workset
Returns:The Runs included in the container
Return type:list of NXOpen.NXObject

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

IsRunIncludedInSubset

LogicalDesignService.IsRunIncludedInSubset

Returns true if the supplied NXOpen.PLAS.Run is included in given Assemblies.Component that represents a container for the Routing design, such as a subset in Workset

Signature IsRunIncludedInSubset(container, run)

Parameters:
  • container (NXOpen.Assemblies.Component) – A component that represents the container that holds the Routing design, such as a subset in a workset
  • run (NXOpen.NXObject) – The Run that needs to be check whether it is in subset or not
Returns:

The logical will be true if supplied run is fully loaded in subset
Return type:

bool

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

LoadAllComponents

LogicalDesignService.LoadAllComponents

Adds a NXOpen.PLAS.Run in Assemblies.Subset which is currently set as work part.

Signature LoadAllComponents(run)

Parameters:run (NXOpen.NXObject) – The Run that needs to be added in subset

New in version NX12.0.0.

License requirements: routing_base (“Routing Basic”)

MakeRunActive

LogicalDesignService.MakeRunActive

Makes a NXOpen.PLAS.Run active in given Assemblies.Component that represents a container for the Routing design, such as a subset in Workset

Signature MakeRunActive(container, run)

Parameters:
  • container (NXOpen.Assemblies.Component) – A component that represents the container that holds the Routing design, such as a subset in a workset
  • run (NXOpen.NXObject) – The Run that needs to be made active

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

ReassignComponentsFromLogicalConnection

LogicalDesignService.ReassignComponentsFromLogicalConnection

Reassigns all the components from a source logical connection object to a destination logical connection object or run object.

Signature ReassignComponentsFromLogicalConnection(container, sourceLogicalConnection, destinationObject)

Parameters:

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

ReassignComponentsToRun

LogicalDesignService.ReassignComponentsToRun

Reassigns a list of Assemblies.Component mapping to a destination run object.

Signature ReassignComponentsToRun(components, run)

Parameters:

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

Unassign3DPortsFromLogicalPort

LogicalDesignService.Unassign3DPortsFromLogicalPort

Unassigns the 3D ports from the logical port object.

Signature Unassign3DPortsFromLogicalPort(container, logicalPort)

Parameters:

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

UnassignComponentToLogicalEquipment

LogicalDesignService.UnassignComponentToLogicalEquipment

Unassigns all the components that are currently assigned to the given logical equipment object.

Signature UnassignComponentToLogicalEquipment(container, logicalEquipment)

Parameters:

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

UnassignComponentsToLogicalConnection

LogicalDesignService.UnassignComponentsToLogicalConnection

Unassigns all the components currently assigned to this logical connection object.

Signature UnassignComponentsToLogicalConnection(container, logicalConnection)

Parameters:
  • container (NXOpen.Assemblies.Component) – A component that represents the container that holds the Routing design. E.g, a subset in a workset
  • logicalConnection (NXOpen.NXObject) – The logical connection object.

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)