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: - logicalPort (
NXOpen.NXObject
) – The logical port. - physicalPort (
NXOpen.Routing.Port
) – The 3D port.
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
- logicalPort (
AssignComponentToLogicalEquipment¶
-
LogicalDesignService.
AssignComponentToLogicalEquipment
¶ Assigns a component
Assemblies.Component
to a logical equipment object.Signature
AssignComponentToLogicalEquipment(logicalEquipment, component)
Parameters: - logicalEquipment (
NXOpen.NXObject
) – The logical equipment object. - component (
NXOpen.Assemblies.Component
) – TheAssemblies.Component
represents a 3D routing equipment.
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
- logicalEquipment (
AssignComponentsToLogicalConnection¶
-
LogicalDesignService.
AssignComponentsToLogicalConnection
¶ Assigns a list of
Assemblies.Component
mapping to a logical connection object.Signature
AssignComponentsToLogicalConnection(components, logicalConnection)
Parameters: - components (list of
NXOpen.Assemblies.Component
) – A list of Components to assign to the logical connection. - logicalConnection (
NXOpen.NXObject
) – The logical connection object.
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
- components (list of
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 worksetSignature
EnsureLogicalModelIsLoaded(container)
Parameters: container ( NXOpen.Assemblies.Component
) – A component that represents the container that holds the Routing design such as a subset in a worksetNew in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
GetActiveRun¶
-
LogicalDesignService.
GetActiveRun
¶ Gets a
NXOpen.PLAS.Run
that is currently active in givenAssemblies.Component
that represents a container for the Routing design, such as a subset in a worksetSignature
GetActiveRun(container)
Parameters: container ( NXOpen.Assemblies.Component
) – A component that represents the container that holds the Routing design such as a subset in a worksetReturns: 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: - routingObject (
NXOpen.NXObject
) – - container (
NXOpen.Assemblies.Component
) –
Returns: Return type: New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
- routingObject (
GetMappingStatusMessage¶
-
LogicalDesignService.
GetMappingStatusMessage
¶ Returns the mapping status message from logical design to physical design.
Signature
GetMappingStatusMessage(routingObject, container)
Parameters: - routingObject (
NXOpen.NXObject
) – - container (
NXOpen.Assemblies.Component
) –
Returns: Return type: str
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
- routingObject (
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 worksetSignature
GetRunsInContainer(container)
Parameters: container ( NXOpen.Assemblies.Component
) – A component that represents the container that holds the Routing design, such as a subset in a worksetReturns: 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 givenAssemblies.Component
that represents a container for the Routing design, such as a subset in WorksetSignature
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”)
- container (
LoadAllComponents¶
-
LogicalDesignService.
LoadAllComponents
¶ Adds a
NXOpen.PLAS.Run
inAssemblies.Subset
which is currently set as work part.Signature
LoadAllComponents(run)
Parameters: run ( NXOpen.NXObject
) – The Run that needs to be added in subsetNew in version NX12.0.0.
License requirements: routing_base (“Routing Basic”)
MakeRunActive¶
-
LogicalDesignService.
MakeRunActive
¶ Makes a
NXOpen.PLAS.Run
active in givenAssemblies.Component
that represents a container for the Routing design, such as a subset in WorksetSignature
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”)
- container (
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: - container (
NXOpen.Assemblies.Component
) – The component of the subset in the workset. - sourceLogicalConnection (
NXOpen.NXObject
) – The source logical connection object. - destinationObject (
NXOpen.NXObject
) – The destination logical connection object or run object.
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
- container (
ReassignComponentsToRun¶
-
LogicalDesignService.
ReassignComponentsToRun
¶ Reassigns a list of
Assemblies.Component
mapping to a destination run object.Signature
ReassignComponentsToRun(components, run)
Parameters: - components (list of
NXOpen.Assemblies.Component
) – A list of Components to reassign to the run. - run (
NXOpen.NXObject
) – The run object.
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
- components (list of
Unassign3DPortsFromLogicalPort¶
-
LogicalDesignService.
Unassign3DPortsFromLogicalPort
¶ Unassigns the 3D ports from the logical port object.
Signature
Unassign3DPortsFromLogicalPort(container, logicalPort)
Parameters: - container (
NXOpen.Assemblies.Component
) – The component of the subset in the workset. - logicalPort (
NXOpen.NXObject
) – The logical port.
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
- container (
UnassignComponentToLogicalEquipment¶
-
LogicalDesignService.
UnassignComponentToLogicalEquipment
¶ Unassigns all the components that are currently assigned to the given logical equipment object.
Signature
UnassignComponentToLogicalEquipment(container, logicalEquipment)
Parameters: - container (
NXOpen.Assemblies.Component
) – A component that represents the container that holds the Routing design - logicalEquipment (
NXOpen.NXObject
) – The logical equipment object.
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
- container (
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”)
- container (