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

Public Types
enum	MappingStatus { MappingStatusPass, MappingStatusOutOfDate, MappingStatusUnloaded, MappingStatusFail, MappingStatusUnknown }
	The status returned from checking the logical design mapping to physical design. More...

Public Member Functions
void	Assign3DPortToLogicalPort (NXOpen::NXObject logicalPort, NXOpen::Routing::Port physicalPort)
	Assigns a 3D Routing::Port mapping to a logical port object. More...

void	AssignComponentsToLogicalConnection (const std::vector< NXOpen::Assemblies::Component * > &components, NXOpen::NXObject *logicalConnection)
	Assigns a list of Assemblies::Component mapping to a logical connection object. More...

void	AssignComponentToLogicalEquipment (NXOpen::NXObject logicalEquipment, NXOpen::Assemblies::Component component)
	Assigns a component Assemblies::Component to a logical equipment object. More...

void	DeleteRuns (const std::vector< NXOpen::NXObject * > &runs)
	Deletes run objects. More...

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 Created in NX11.0.0. More...

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...

NXOpen::MechanicalRouting::LogicalDesignService::MappingStatus	GetMappingStatus (NXOpen::NXObject routingObject, NXOpen::Assemblies::Component container)
	Returns the mapping status from the logical design to physical design. More...

NXString	GetMappingStatusMessage (NXOpen::NXObject routingObject, NXOpen::Assemblies::Component container)
	Returns the mapping status message from logical design to physical design. More...

std::vector< 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...

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...

void	LoadAllComponents (NXOpen::NXObject *run)
	Adds a NXOpen::PLAS::Run in Assemblies::Subset which is currently set as work part. More...

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 Created in NX11.0.0. More...

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...

void	ReassignComponentsToRun (const std::vector< NXOpen::Assemblies::Component * > &components, NXOpen::NXObject *run)
	Reassigns a list of Assemblies::Component mapping to a destination run object. More...

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

void	Unassign3DPortsFromLogicalPort (NXOpen::Assemblies::Component container, NXOpen::NXObject logicalPort)
	Unassigns the 3D ports from the logical port object. More...

void	UnassignComponentsToLogicalConnection (NXOpen::Assemblies::Component container, NXOpen::NXObject logicalConnection)
	Unassigns all the components currently assigned to this logical connection object. More...

void	UnassignComponentToLogicalEquipment (NXOpen::Assemblies::Component container, NXOpen::NXObject logicalEquipment)
	Unassigns all the components that are currently assigned to the given logical equipment object. 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
MappingStatusPass	pass
MappingStatusOutOfDate	out of date
MappingStatusUnloaded	unloaded
MappingStatusFail	fail
MappingStatusUnknown	unknown

Member Function Documentation

void NXOpen::MechanicalRouting::LogicalDesignService::Assign3DPortToLogicalPort	(	NXOpen::NXObject *	logicalPort,
		NXOpen::Routing::Port *	physicalPort
	)

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.

void NXOpen::MechanicalRouting::LogicalDesignService::AssignComponentsToLogicalConnection	(	const std::vector< NXOpen::Assemblies::Component * > &	components,
		NXOpen::NXObject *	logicalConnection
	)

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.

void NXOpen::MechanicalRouting::LogicalDesignService::AssignComponentToLogicalEquipment	(	NXOpen::NXObject *	logicalEquipment,
		NXOpen::Assemblies::Component *	component
	)

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.

void NXOpen::MechanicalRouting::LogicalDesignService::DeleteRuns ( const std::vector< NXOpen::NXObject * > & runs )

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.

void NXOpen::MechanicalRouting::LogicalDesignService::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
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

NXOpen::NXObject* NXOpen::MechanicalRouting::LogicalDesignService::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.

Returns: The currently active Run. Can be null if no active Run is present
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

NXOpen::MechanicalRouting::LogicalDesignService::MappingStatus NXOpen::MechanicalRouting::LogicalDesignService::GetMappingStatus	(	NXOpen::NXObject *	routingObject,
		NXOpen::Assemblies::Component *	container
	)

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

Returns: Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

routingObject	routingobject
container	container

NXString NXOpen::MechanicalRouting::LogicalDesignService::GetMappingStatusMessage	(	NXOpen::NXObject *	routingObject,
		NXOpen::Assemblies::Component *	container
	)

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

Returns: Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

routingObject	routingobject
container	container

std::vector<NXOpen::NXObject *> NXOpen::MechanicalRouting::LogicalDesignService::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.

Returns: The Runs included in the container
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

bool NXOpen::MechanicalRouting::LogicalDesignService::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.

Returns: The logical will be true if supplied run is fully loaded in subset
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

void NXOpen::MechanicalRouting::LogicalDesignService::LoadAllComponents ( NXOpen::NXObject * run )

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

void NXOpen::MechanicalRouting::LogicalDesignService::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
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

void NXOpen::MechanicalRouting::LogicalDesignService::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.

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.

void NXOpen::MechanicalRouting::LogicalDesignService::ReassignComponentsToRun	(	const std::vector< NXOpen::Assemblies::Component * > &	components,
		NXOpen::NXObject *	run
	)

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.

tag_t NXOpen::MechanicalRouting::LogicalDesignService::Tag ( ) const

Returns the tag of this object.

void NXOpen::MechanicalRouting::LogicalDesignService::Unassign3DPortsFromLogicalPort	(	NXOpen::Assemblies::Component *	container,
		NXOpen::NXObject *	logicalPort
	)

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.

void NXOpen::MechanicalRouting::LogicalDesignService::UnassignComponentsToLogicalConnection	(	NXOpen::Assemblies::Component *	container,
		NXOpen::NXObject *	logicalConnection
	)

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.

void NXOpen::MechanicalRouting::LogicalDesignService::UnassignComponentToLogicalEquipment	(	NXOpen::Assemblies::Component *	container,
		NXOpen::NXObject *	logicalEquipment
	)

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.

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

MechanicalRouting_LogicalDesignService.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation