NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.MechanicalRouting.PartPlacementBuilder Class Reference

Represents NXOpen.MechanicalRouting.PartPlacementBuilder . More...

Inheritance diagram for NXOpen.MechanicalRouting.PartPlacementBuilder:
NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  PositionAsType { Routing, Equipment }
 The positioning types More...
 
enum  PlacementValidationStatus { Success, PartNotConnectedToRout }
 The placement validation status More...
 

Public Member Functions

unsafe void SetFileSpecificationOfPartToPlace (string filename)
 Sets the file specification of the part to place More...
 
unsafe void SetClassificationObjectIdentifier (string classificationObjectId)
 Sets the identifier of the classification object associated with the part to place More...
 
unsafe void SetReferenceObjectForPlacement (NXOpen.TaggedObject referenceObject, NXOpen.Point3d referencePositionPoint)
 Sets the reference object and reference location for placement. More...
 
unsafe NXOpen.BasePart LoadPart ()
 Loads the BasePart 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 ProcessComponentsForEdit ()
 Processes the Assemblies.Component s to edit their placement More...
 
unsafe
NXOpen.Placement.PlacementEngineBuilder 
InitializePlacementEngineBuilder ()
 Initializes the Placement Engine builder with input already present in the Part Placement Builder. More...
 
unsafe void PreCommitThisPlacement ()
 Pre commits the current placement operation to prepare data (ex. More...
 
unsafe void ProcessPlacedPart ()
 Processes the placed part. More...
 
unsafe
NXOpen.Assemblies.Component[] 
ProcessPostPlaceParts ()
 Process the post placement parts (ex. 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
NXOpen.Assemblies.Component[] 
ProcessCompatibilityPostPlaceParts ()
 Process the compatibility post placement parts (ex. More...
 
unsafe void PrepareDataForConnectivity ()
 Prepare data to build connectivity for all placed parts. More...
 
unsafe
NXOpen.MechanicalRouting.PartPlacementBuilder.PlacementValidationStatus 
CommitThisPlacement ()
 Commits the current placement operation. More...
 
unsafe void SetPrimarySolutionsFlag (bool showPrimarySolutions)
 Sets the primary solutions flag on builder. More...
 
unsafe
NXOpen.Placement.PlacementSolution[] 
GetFilteredPlacementSolutions ()
 Filters placement solutions based existing filtration flags in builder ex. More...
 
unsafe void SetPortOfPlaceableObject (NXOpen.TaggedObject sourcePortObject)
 Sets the port for filtration from the part being placed. More...
 
unsafe void SetPositionAsOption (NXOpen.MechanicalRouting.PartPlacementBuilder.PositionAsType positioningType)
 Sets the positioning option NXOpen.MechanicalRouting.PartPlacementBuilder.PositionAsType on the builder. 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 SetClassificationObjectIdentifierOfPartToPostPlace (string classificationObjectId)
 Sets the identifier of the classification object associated with the part to be post placed. 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 UpdateReferenceSet (string referenseSetName)
 Updates the reference set for the Design Elements created during part placement operation. More...
 
unsafe void UpdateLayer (int layerNumber)
 Updates the layer for the Design Elements created during part placement operation. More...
 
unsafe void AutoAssignAttributes ()
 Auto assign the auto assignable attributes of all 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 void GetLogicalObjects (out NXOpen.PDM.LogicalObject[] logicalObjects)
 Returns the PDM.LogicalObject s that were created during part placement operation. More...
 
unsafe int GetErrorCodeForPlacementSolution (NXOpen.Placement.PlacementSolution placementSolution)
 Returns the error code for a placement solution. 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 NXOpen.Routing.Port GetPortAtCutSideOfElbow ()
 Get the port from cut side of cut elbow 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...
 

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

Detailed Description

Represents NXOpen.MechanicalRouting.PartPlacementBuilder .

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

Created in NX11.0.0

Member Enumeration Documentation

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

The positioning types

Enumerator
Routing 

position as inline routing fitting

Equipment 

position as equipment

Member Function Documentation

unsafe void NXOpen.MechanicalRouting.PartPlacementBuilder.AutoAssignAttributes ( )

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.MechanicalRouting.PartPlacementBuilder.PlacementValidationStatus NXOpen.MechanicalRouting.PartPlacementBuilder.CommitThisPlacement ( )

Commits the current placement operation.

This method must be called after calling method MechanicalRouting.PartPlacementBuilder.PreCommitThisPlacement . This method returns NXOpen.MechanicalRouting.PartPlacementBuilder.PlacementValidationStatus value

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

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

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
referenceSetreference set to apply on part occurrence
layerlayer
Returns
created part occurrence
unsafe NXOpen.Routing.Port NXOpen.MechanicalRouting.PartPlacementBuilder.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)

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.MechanicalRouting.PartPlacementBuilder.GetErrorCodeForPlacementSolution ( NXOpen.Placement.PlacementSolution  placementSolution)

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.MechanicalRouting.PartPlacementBuilder.GetFilteredPlacementSolutions ( )

Filters placement solutions based existing filtration flags in builder ex.

primary.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

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

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.MechanicalRouting.PartPlacementBuilder.GetLogicalObjectsHavingUnassignedRequiredAttributes ( out NXOpen.PDM.LogicalObject[]  logicalObjects)

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.MechanicalRouting.PartPlacementBuilder.GetPortAtCutSideOfElbow ( )

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.MechanicalRouting.PartPlacementBuilder.InitializePlacementEngineBuilder ( )

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.BasePart NXOpen.MechanicalRouting.PartPlacementBuilder.LoadPart ( )

Loads the BasePart to place.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Returns
loaded part
unsafe void NXOpen.MechanicalRouting.PartPlacementBuilder.PreCommitThisPlacement ( )

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 MechanicalRouting.PartPlacementBuilder.CommitThisPlacement to complete the placement operation

Created in NX11.0.0

Deprecated in NX12.0.0. Use MechanicalRouting.PartPlacementBuilder.ProcessPlacedPart followed by MechanicalRouting.PartPlacementBuilder.PrepareDataForConnectivity .

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.MechanicalRouting.PartPlacementBuilder.PrepareDataForConnectivity ( )

Prepare data to build connectivity for all placed parts.

Things like computation of new stock DE (resultant of splitting) will happen here. This method must be followed by a call to final commit method MechanicalRouting.PartPlacementBuilder.CommitThisPlacement to complete the placement operation

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

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

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.MechanicalRouting.PartPlacementBuilder.ProcessComponentsForEdit ( )

Processes the Assemblies.Component s to edit their placement

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.MechanicalRouting.PartPlacementBuilder.ProcessPlacedPart ( )

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.MechanicalRouting.PartPlacementBuilder.ProcessPostPlaceParts ( )

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.MechanicalRouting.PartPlacementBuilder.RotatePlaceableObjectByAngle ( double  rotationAngle)

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.MechanicalRouting.PartPlacementBuilder.SetAddUnconnectedEquipmentToActiveRunOption ( bool  canAddEquipmentToActiveRun)

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
canAddEquipmentToActiveRunFlag when true will result in parts positioned as Equipment to be added to the active Run.
unsafe void NXOpen.MechanicalRouting.PartPlacementBuilder.SetClassificationObjectIdentifier ( string  classificationObjectId)

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

Created in NX12.0.0

License requirements: routing_base ("Routing Basic")

Parameters
ccType
classificationObjectId
portOneOne of the ports at the intersection where compatible part needs to be placed.
portTwoOther port at the intersection where compatible part needs to be placed.
unsafe void NXOpen.MechanicalRouting.PartPlacementBuilder.SetClassificationObjectIdentifierOfPartToPostPlace ( string  classificationObjectId)

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.MechanicalRouting.PartPlacementBuilder.SetFileSpecificationOfPartToPlace ( string  filename)

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.MechanicalRouting.PartPlacementBuilder.SetPortOfPlaceableObject ( NXOpen.TaggedObject  sourcePortObject)

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.MechanicalRouting.PartPlacementBuilder.SetPositionAsOption ( NXOpen.MechanicalRouting.PartPlacementBuilder.PositionAsType  positioningType)

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

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters
positioningType
unsafe void NXOpen.MechanicalRouting.PartPlacementBuilder.SetPrimarySolutionsFlag ( bool  showPrimarySolutions)

Sets the primary solutions flag on builder.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters
showPrimarySolutions
unsafe void NXOpen.MechanicalRouting.PartPlacementBuilder.SetReferenceObjectForPlacement ( NXOpen.TaggedObject  referenceObject,
NXOpen.Point3d  referencePositionPoint 
)

Sets the reference object and reference location for placement.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters
referenceObjectNew object to attach to. Can be NULL.
referencePositionPointThe new location for the part.
unsafe void NXOpen.MechanicalRouting.PartPlacementBuilder.UpdateLayer ( int  layerNumber)

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.MechanicalRouting.PartPlacementBuilder.UpdateReferenceSet ( string  referenseSetName)

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.MechanicalRouting.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.MechanicalRouting.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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.