NXOpen.MechanicalRouting.LogicalDesignService Class Reference

Represents a NXOpen.MechanicalRouting.LogicalDesignService object. More...

Inheritance diagram for NXOpen.MechanicalRouting.LogicalDesignService:

Public Types
enum	MappingStatus {   Pass, OutOfDate, Unloaded, Fail,   Unknown, ConnectionChanged, ParentRunNotConfiguredOrDeleted, OneOrMoreRunBranchesNotSavedToTeamcenter,   RunBranchNotSavedToTeamcenter, DeviationOfDiscipline, DeviationOfSpecification, DeviationOfDiscAndSpec }
	The status returned from checking the logical design mapping to physical design. More...

Public Member Functions
unsafe void	Assign3DPortToLogicalPort (NXOpen.NXObject logicalPort, NXOpen.Routing.Port physicalPort)
	Assigns a 3D Routing.Port mapping to a logical port object. More...
unsafe void	AssignComponentsToLogicalConnection (NXOpen.Assemblies.Component[] components, NXOpen.NXObject logicalConnection)
	Assigns a list of Assemblies.Component mapping to a logical connection object. More...
unsafe void	AssignComponentToLogicalEquipment (NXOpen.NXObject logicalEquipment, NXOpen.Assemblies.Component component)
	Assigns a component Assemblies.Component to a logical equipment object. More...
unsafe void	DeleteRuns (NXOpen.NXObject[] runs)
	Deletes run objects. More...
unsafe void	EnsureLogicalModelIsLoaded (NXOpen.Assemblies.Component container)
	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 More...
unsafe NXOpen.NXObject	GetActiveRun (NXOpen.Assemblies.Component container)
	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 More...
unsafe NXOpen.MechanicalRouting.LogicalDesignService.MappingStatus	GetMappingStatus (NXOpen.NXObject routingObject, NXOpen.Assemblies.Component container)
	Returns the mapping status from the logical design to physical design. More...
unsafe string	GetMappingStatusMessage (NXOpen.NXObject routingObject, NXOpen.Assemblies.Component container)
	Returns the mapping status message from logical design to physical design. More...
unsafe NXOpen.NXObject[]	GetRunsInContainer (NXOpen.Assemblies.Component container)
	Gets the NXOpen.PLAS.Run s that are included in a given Assemblies.Component that represents a container for the Routing design, such as a subset in a workset More...
unsafe bool	IsRunIncludedInSubset (NXOpen.Assemblies.Component container, NXOpen.NXObject run)
	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 More...
unsafe void	LoadAllComponents (NXOpen.NXObject run)
	Adds a NXOpen.PLAS.Run in Assemblies.Subset which is currently set as work part. More...
unsafe void	MakeRunActive (NXOpen.Assemblies.Component container, NXOpen.NXObject run)
	Makes a NXOpen.PLAS.Run active in given Assemblies.Component that represents a container for the Routing design, such as a subset in Workset More...
unsafe void	ReassignComponentsFromLogicalConnection (NXOpen.Assemblies.Component container, NXOpen.NXObject sourceLogicalConnection, NXOpen.NXObject destinationObject)
	Reassigns all the components from a source logical connection object to a destination logical connection object or run object. More...
unsafe void	ReassignComponentsToRun (NXOpen.Assemblies.Component[] components, NXOpen.NXObject run)
	Reassigns a list of Assemblies.Component mapping to a destination run object. More...
unsafe void	Unassign3DPortsFromLogicalPort (NXOpen.Assemblies.Component container, NXOpen.NXObject logicalPort)
	Unassigns the 3D ports from the logical port object. More...
unsafe void	UnassignComponentsToLogicalConnection (NXOpen.Assemblies.Component container, NXOpen.NXObject logicalConnection)
	Unassigns all the components currently assigned to this logical connection object. More...
unsafe void	UnassignComponentToLogicalEquipment (NXOpen.Assemblies.Component container, NXOpen.NXObject logicalEquipment)
	Unassigns all the components that are currently assigned to the given logical equipment object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
Tag	Tag [get]
	Returns the tag of this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> More...

Detailed Description

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

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.MechanicalRouting.LogicalDesignService.MappingStatus

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

Enumerator
Pass
OutOfDate
Unloaded
Fail
Unknown
ConnectionChanged
ParentRunNotConfiguredOrDeleted
OneOrMoreRunBranchesNotSavedToTeamcenter
RunBranchNotSavedToTeamcenter
DeviationOfDiscipline
DeviationOfSpecification
DeviationOfDiscAndSpec

Member Function Documentation

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.Assign3DPortToLogicalPort ( NXOpen.NXObject  logicalPort, NXOpen.Routing.Port  physicalPort  )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

logicalPort	The logical port.
physicalPort	The 3D port.

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.AssignComponentsToLogicalConnection ( NXOpen.Assemblies.Component[]  components, NXOpen.NXObject  logicalConnection  )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

components	A list of Components to assign to the logical connection.
logicalConnection	The logical connection object.

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.AssignComponentToLogicalEquipment ( NXOpen.NXObject  logicalEquipment, NXOpen.Assemblies.Component  component  )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

logicalEquipment	The logical equipment object.
component	The Assemblies.Component represents a 3D routing equipment.

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.DeleteRuns ( NXOpen.NXObject[]  runs )

inline

Deletes run objects.

NOTE: only the empty run object can be deleted.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

runs	The run objects.

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.EnsureLogicalModelIsLoaded ( NXOpen.Assemblies.Component  container )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

container

A component that represents the container that holds the Routing design such as a subset in a workset

unsafe NXOpen.NXObject NXOpen.MechanicalRouting.LogicalDesignService.GetActiveRun ( NXOpen.Assemblies.Component  container )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

container

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

unsafe NXOpen.MechanicalRouting.LogicalDesignService.MappingStatus NXOpen.MechanicalRouting.LogicalDesignService.GetMappingStatus ( NXOpen.NXObject  routingObject, NXOpen.Assemblies.Component  container  )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

routingObject
container

Returns

unsafe string NXOpen.MechanicalRouting.LogicalDesignService.GetMappingStatusMessage ( NXOpen.NXObject  routingObject, NXOpen.Assemblies.Component  container  )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

routingObject
container

Returns

unsafe NXOpen.NXObject [] NXOpen.MechanicalRouting.LogicalDesignService.GetRunsInContainer ( NXOpen.Assemblies.Component  container )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

container

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

unsafe bool NXOpen.MechanicalRouting.LogicalDesignService.IsRunIncludedInSubset ( NXOpen.Assemblies.Component  container, NXOpen.NXObject  run  )

inline

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

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

Parameters

container	A component that represents the container that holds the Routing design, such as a subset in a workset
run	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

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.LoadAllComponents ( NXOpen.NXObject  run )

inline

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

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

Parameters

run	The Run that needs to be added in subset

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.MakeRunActive ( NXOpen.Assemblies.Component  container, NXOpen.NXObject  run  )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

container	A component that represents the container that holds the Routing design, such as a subset in a workset
run	The Run that needs to be made active

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.ReassignComponentsFromLogicalConnection ( NXOpen.Assemblies.Component  container, NXOpen.NXObject  sourceLogicalConnection, NXOpen.NXObject  destinationObject  )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

container	The component of the subset in the workset.
sourceLogicalConnection	The source logical connection object.
destinationObject	The destination logical connection object or run object.

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.ReassignComponentsToRun ( NXOpen.Assemblies.Component[]  components, NXOpen.NXObject  run  )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

components	A list of Components to reassign to the run.
run	The run object.

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.Unassign3DPortsFromLogicalPort ( NXOpen.Assemblies.Component  container, NXOpen.NXObject  logicalPort  )

inline

Unassigns the 3D ports from the logical port object.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

container	The component of the subset in the workset.
logicalPort	The logical port.

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.UnassignComponentsToLogicalConnection ( NXOpen.Assemblies.Component  container, NXOpen.NXObject  logicalConnection  )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

container	A component that represents the container that holds the Routing design. E.g, a subset in a workset
logicalConnection	The logical connection object.

unsafe void NXOpen.MechanicalRouting.LogicalDesignService.UnassignComponentToLogicalEquipment ( NXOpen.Assemblies.Component  container, NXOpen.NXObject  logicalEquipment  )

inline

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

container	A component that represents the container that holds the Routing design
logicalEquipment	The logical equipment object.

Property Documentation

Tag NXOpen.MechanicalRouting.LogicalDesignService.Tag

get

Returns the tag of this object.

---

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

• MechanicalRouting_LogicalDesignService.cs