Represents NXOpen.RoutingCommon.PartPlacementBuilder . More...

Inheritance diagram for NXOpen.RoutingCommon.PartPlacementBuilder:

Public Types
enum	PlacementValidationStatus { Success, PartNotConnectedToRout }
	The placement validation status More...

enum	PositionAsType { Routing, Equipment }
	The positioning types More...

Public Member Functions
unsafe void	AutoAssignAttributes ()
	Auto assign the auto assignable attributes of all PDM.LogicalObject s that were created during part placement operation. More...

unsafe NXOpen.RoutingCommon.PartPlacementBuilder.PlacementValidationStatus	CommitThisPlacement ()
	Commits the current placement operation. More...

unsafe void	CopyAttributesToPartToPlace (NXOpen.Assemblies.Component sourcePartOccurrence)
	Copies user defined attributes from given component to the component to place. More...

unsafe NXOpen.Assemblies.Component	CreatePartOccurrenceToPlace (string referenceSet, int layer)
	Creates the Assemblies.Component for part to place with given reference set and layer. More...

unsafe void	DesignateComponentForPlacementSolutionComputation (NXOpen.Assemblies.Component partOccurrence)
	Designates the component to be used for placement solution computation. More...

unsafe NXOpen.Routing.Port	GetCoincidentPortForCompatibility (NXOpen.Routing.Port portFromPlacedPart)
	Get compatibility port from port of placed part (ex in case of Valve-Flange get corresponding coincident Flange port from Valve port) More...

unsafe int	GetErrorCodeForPlacementSolution (NXOpen.Placement.PlacementSolution placementSolution)
	Returns the error code for a placement solution. More...

unsafe NXOpen.Placement.PlacementSolution[]	GetFilteredPlacementSolutions ()
	Filters placement solutions based existing filtration flags in builder ex. More...

unsafe NXOpen.Routing.AttributeHolder	GetLibraryDefinedAttributeHolder ()
	Gets the attribute holder for library defined attributes on placed part instance More...

unsafe NXOpen.Routing.AttributeHolder	GetLibraryDefinedPostPlacementAttributeHolder ()
	Gets the attribute holder for library defined attributes on post placed part instance More...

unsafe void	GetLogicalObjects (out NXOpen.PDM.LogicalObject[] logicalObjects)
	Returns the PDM.LogicalObject s that were created during part placement operation. More...

unsafe void	GetLogicalObjectsHavingUnassignedRequiredAttributes (out NXOpen.PDM.LogicalObject[] logicalObjects)
	Returns the PDM.LogicalObject s having unassigned non-auto-assignable required attributes. More...

unsafe NXOpen.Routing.Port	GetPortAtCutSideOfElbow ()
	Get the port from cut side of cut elbow More...

unsafe NXOpen.Placement.PlacementEngineBuilder	InitializePlacementEngineBuilder ()
	Initializes the Placement Engine builder with input already present in the Pabrt Placement Builder. More...

unsafe NXOpen.BasePart	LoadPart ()
	Loads the BasePart to place. More...

unsafe void	PreCommitThisPlacement ()
	Pre commits the current placement operation to prepare data (ex. More...

unsafe void	PrepareDataForConnectivity ()
	Prepare data to build connectivity for all placed parts. More...

unsafe NXOpen.Assemblies.Component[]	ProcessCompatibilityPostPlaceParts ()
	Process the compatibility post placement parts (ex. More...

unsafe void	ProcessComponentsForEdit ()
	Processes the Assemblies.Component s to edit their placement More...

unsafe void	ProcessPlacedPart ()
	Processes the placed part. More...

unsafe NXOpen.Assemblies.Component[]	ProcessPostPlaceParts ()
	Process the post placement parts (ex. More...

unsafe void	ResetAttributesOnLibraryDefinedAttributeHolder ()
	Resets the attribute holder for library defined attributes for part to be placed This API is recommended to be used before assigning attributes onto builder so as to ensure part placement to function correctly More...

unsafe void	ResetAttributesOnPostPlaceLibraryDefinedAttributeHolder ()
	Resets the attribute holder for library defined attributes for post placement parts to be placed This API is recommended to be used before assigning attributes onto builder so as to ensure post placement parts to function correctly More...

unsafe void	RotatePlaceableObjectByAngle (double rotationAngle)
	Rotates the fitting by the specified angle along the plane perpendicular to the vector defined by the engaged port. More...

unsafe void	SetAddUnconnectedEquipmentToActiveRunOption (bool canAddEquipmentToActiveRun)
	Sets the option that determines whether a part positioned as Equipment should be added to the active Run More...

unsafe void	SetClassificationObjectIdentifier (string classificationObjectId)
	Sets the identifier of the classification object associated with the part to place More...

unsafe void	SetClassificationObjectIdentifierOfCompatibilityPart (NXOpen.Routing.ReuseLibrary.PartType ccType, string classificationObjectId, NXOpen.Routing.Port portOne, NXOpen.Routing.Port portTwo)
	Sets the identifier of the classification object associated with the compatibility part to post place More...

unsafe void	SetClassificationObjectIdentifierOfPartToPostPlace (string classificationObjectId)
	Sets the identifier of the classification object associated with the part to be post placed. More...

unsafe void	SetFileSpecificationOfPartToPlace (string filename)
	Sets the file specification of the part to place More...

unsafe void	SetPortOfPlaceableObject (NXOpen.TaggedObject sourcePortObject)
	Sets the port for filtration from the part being placed. More...

unsafe void	SetPositionAsOption (NXOpen.RoutingCommon.PartPlacementBuilder.PositionAsType positioningType)
	Sets the positioning option NXOpen.RoutingCommon.PartPlacementBuilder.PositionAsType on the builder. More...

unsafe void	SetPrimarySolutionsFlag (bool showPrimarySolutions)
	Sets the primary solutions flag on builder. More...

unsafe void	SetReferenceObjectForPlacement (NXOpen.TaggedObject referenceObject, NXOpen.Point3d referencePositionPoint)
	Sets the reference object and reference location for placement. More...

unsafe void	UpdateLayer (int layerNumber)
	Updates the layer for the Design Elements created during part placement operation. More...

unsafe void	UpdateReferenceSet (string referenseSetName)
	Updates the reference set for the Design Elements created during part placement operation. More...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current 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
unsafe NXOpen.Routing.RouteObjectCollector	ComponentsToEditCollector `[get]`
	Returns the NXOpen.Routing.RouteObjectCollector that collects components to edit More...

unsafe NXOpen.NXObject	LogicalDesignObject `[get, set]`
	Returns or sets the mapping logical design object More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
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.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents NXOpen.RoutingCommon.PartPlacementBuilder .

To create a new instance of this class, use NXOpen.RoutingCommon.BuilderFactory.CreatePartPlacementBuilder

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.RoutingCommon.PartPlacementBuilder.PlacementValidationStatus

The placement validation status

Enumerator
Success	part placement is successful as expected
PartNotConnectedToRout	after placement connection should have been built with routing system but it was not

enum NXOpen.RoutingCommon.PartPlacementBuilder.PositionAsType

The positioning types

Enumerator
Routing	position as inline routing fitting
Equipment	position as equipment

Member Function Documentation

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.AutoAssignAttributes ( )

inline

Auto assign the auto assignable attributes of all PDM.LogicalObject s that were created during part placement operation.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.RoutingCommon.PartPlacementBuilder.PlacementValidationStatus NXOpen.RoutingCommon.PartPlacementBuilder.CommitThisPlacement ( )

inline

Commits the current placement operation.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.CopyAttributesToPartToPlace ( NXOpen.Assemblies.Component sourcePartOccurrence )

inline

Copies user defined attributes from given component to the component to place.

The attributes attributes are copied from instance to instance and component to component. Attributes will be copied only if the given component and the component to place are of same part.

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Parameters

sourcePartOccurrence

unsafe NXOpen.Assemblies.Component NXOpen.RoutingCommon.PartPlacementBuilder.CreatePartOccurrenceToPlace	(	string	referenceSet,
		int	layer
	)

inline

Creates the Assemblies.Component for part to place with given reference set and layer.

The created component will be used to generate placement solutions. Error will be raised if part to place is not loaded.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

referenceSet	reference set to apply on part occurrence
layer	layer

Returns: created part occurrence

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.DesignateComponentForPlacementSolutionComputation ( NXOpen.Assemblies.Component partOccurrence )

inline

Designates the component to be used for placement solution computation.

When relocating a flage-valve-flange unit, typically the intent is to relocate the valve. Flanges just follow the valve to its new location. In such case, user should designate valve as the component to be used for placement solution computation. If user does not designate any component, placement solutions will be computed on all components which may result in a large number of solutions to choose from.

Created in NX1899.0.0

License requirements: routing_base ("Routing Basic")

Parameters

partOccurrence

unsafe NXOpen.Routing.Port NXOpen.RoutingCommon.PartPlacementBuilder.GetCoincidentPortForCompatibility ( NXOpen.Routing.Port portFromPlacedPart )

inline

Get compatibility port from port of placed part (ex in case of Valve-Flange get corresponding coincident Flange port from Valve port)

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

Parameters

portFromPlacedPart

Returns: Other port at the intersection where compatible part needs to be placed.

unsafe int NXOpen.RoutingCommon.PartPlacementBuilder.GetErrorCodeForPlacementSolution ( NXOpen.Placement.PlacementSolution placementSolution )

inline

Returns the error code for a placement solution.

A non-zero error code may suggest whether there will be any design rule validation due to the given placement solution.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

placementSolution

Returns

unsafe NXOpen.Placement.PlacementSolution [] NXOpen.RoutingCommon.PartPlacementBuilder.GetFilteredPlacementSolutions ( )

inline

Filters placement solutions based existing filtration flags in builder ex.

primary.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe NXOpen.Routing.AttributeHolder NXOpen.RoutingCommon.PartPlacementBuilder.GetLibraryDefinedAttributeHolder ( )

inline

Gets the attribute holder for library defined attributes on placed part instance

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe NXOpen.Routing.AttributeHolder NXOpen.RoutingCommon.PartPlacementBuilder.GetLibraryDefinedPostPlacementAttributeHolder ( )

inline

Gets the attribute holder for library defined attributes on post placed part instance

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.GetLogicalObjects ( out NXOpen.PDM.LogicalObject[] logicalObjects )

inline

Returns the PDM.LogicalObject s that were created during part placement operation.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

logicalObjects

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.GetLogicalObjectsHavingUnassignedRequiredAttributes ( out NXOpen.PDM.LogicalObject[] logicalObjects )

inline

Returns the PDM.LogicalObject s having unassigned non-auto-assignable required attributes.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

logicalObjects

unsafe NXOpen.Routing.Port NXOpen.RoutingCommon.PartPlacementBuilder.GetPortAtCutSideOfElbow ( )

inline

Get the port from cut side of cut elbow

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe NXOpen.Placement.PlacementEngineBuilder NXOpen.RoutingCommon.PartPlacementBuilder.InitializePlacementEngineBuilder ( )

inline

Initializes the Placement Engine builder with input already present in the Pabrt Placement Builder.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe NXOpen.BasePart NXOpen.RoutingCommon.PartPlacementBuilder.LoadPart ( )

inline

Loads the BasePart to place.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Returns: loaded part

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.PreCommitThisPlacement ( )

inline

Pre commits the current placement operation to prepare data (ex.

split stock, post placement, etc) for final commit. This method must be followed by a call to final commit method RoutingCommon.PartPlacementBuilder.CommitThisPlacement to complete the placement operation

Created in NX11.0.0

Deprecated in NX12.0.0. Use RoutingCommon.PartPlacementBuilder.ProcessPlacedPart .

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.PrepareDataForConnectivity ( )

inline

Prepare data to build connectivity for all placed parts.

Things like computation of new stock DE (resultant of splitting) will happen here.

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Assemblies.Component [] NXOpen.RoutingCommon.PartPlacementBuilder.ProcessCompatibilityPostPlaceParts ( )

inline

Process the compatibility post placement parts (ex.

placement of gasket flange after the post placement of flange and do geoemtry operations like split stock, etc). This method will also prepare data needed to build connectivity (connectivity will be built in final commit).

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.ProcessComponentsForEdit ( )

inline

Processes the Assemblies.Component s to edit their placement

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.ProcessPlacedPart ( )

inline

Processes the placed part.

This might split the target stock geometry. This method will also prepare data needed to build connectivity (connectivity will be built in final commit).

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Assemblies.Component [] NXOpen.RoutingCommon.PartPlacementBuilder.ProcessPostPlaceParts ( )

inline

Process the post placement parts (ex.

placement of flange after the valve and do geoemtry operations like split stock, etc). This method will also prepare data needed to build connectivity (connectivity will be built in final commit).

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.ResetAttributesOnLibraryDefinedAttributeHolder ( )

inline

Resets the attribute holder for library defined attributes for part to be placed This API is recommended to be used before assigning attributes onto builder so as to ensure part placement to function correctly

Created in NX1872.0.0

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.ResetAttributesOnPostPlaceLibraryDefinedAttributeHolder ( )

inline

Resets the attribute holder for library defined attributes for post placement parts to be placed This API is recommended to be used before assigning attributes onto builder so as to ensure post placement parts to function correctly

Created in NX1872.0.0

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.RotatePlaceableObjectByAngle ( double rotationAngle )

inline

Rotates the fitting by the specified angle along the plane perpendicular to the vector defined by the engaged port.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

rotationAngle

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.SetAddUnconnectedEquipmentToActiveRunOption ( bool canAddEquipmentToActiveRun )

inline

Sets the option that determines whether a part positioned as Equipment should be added to the active Run

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

canAddEquipmentToActiveRun Flag when true will result in parts positioned as Equipment to be added to the active Run.

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.SetClassificationObjectIdentifier ( string classificationObjectId )

inline

Sets the identifier of the classification object associated with the part to place

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

classificationObjectId

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.SetClassificationObjectIdentifierOfCompatibilityPart	(	NXOpen.Routing.ReuseLibrary.PartType	ccType,
		string	classificationObjectId,
		NXOpen.Routing.Port	portOne,
		NXOpen.Routing.Port	portTwo
	)

inline

Sets the identifier of the classification object associated with the compatibility part to post place

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

Parameters

ccType
classificationObjectId
portOne	One of the ports at the intersection where compatible part needs to be placed.
portTwo	Other port at the intersection where compatible part needs to be placed.

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.SetClassificationObjectIdentifierOfPartToPostPlace ( string classificationObjectId )

inline

Sets the identifier of the classification object associated with the part to be post placed.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

classificationObjectId

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.SetFileSpecificationOfPartToPlace ( string filename )

inline

Sets the file specification of the part to place

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

filename

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.SetPortOfPlaceableObject ( NXOpen.TaggedObject sourcePortObject )

inline

Sets the port for filtration from the part being placed.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

sourcePortObject

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.SetPositionAsOption ( NXOpen.RoutingCommon.PartPlacementBuilder.PositionAsType positioningType )

inline

Sets the positioning option NXOpen.RoutingCommon.PartPlacementBuilder.PositionAsType on the builder.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

positioningType

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.SetPrimarySolutionsFlag ( bool showPrimarySolutions )

inline

Sets the primary solutions flag on builder.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

showPrimarySolutions

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.SetReferenceObjectForPlacement	(	NXOpen.TaggedObject	referenceObject,
		NXOpen.Point3d	referencePositionPoint
	)

inline

Sets the reference object and reference location for placement.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

referenceObject	New object to attach to. Can be NULL.
referencePositionPoint	The new location for the part.

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.UpdateLayer ( int layerNumber )

inline

Updates the layer for the Design Elements created during part placement operation.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

layerNumber

unsafe void NXOpen.RoutingCommon.PartPlacementBuilder.UpdateReferenceSet ( string referenseSetName )

inline

Updates the reference set for the Design Elements created during part placement operation.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

referenseSetName

Property Documentation

unsafe NXOpen.Routing.RouteObjectCollector NXOpen.RoutingCommon.PartPlacementBuilder.ComponentsToEditCollector

get

Returns the NXOpen.Routing.RouteObjectCollector that collects components to edit

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.NXObject NXOpen.RoutingCommon.PartPlacementBuilder.LogicalDesignObject

getset

Returns or sets the mapping logical design object

Created in NX11.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

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

RoutingCommon_PartPlacementBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation