nxopen.routing

Interface PlacePartBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface PlacePartBuilder
extends Builder

To create a new instance of this class, use RouteManager.createPlacePartBuilderPTS(nxopen.TaggedObject, nxopen.TaggedObject, nxopen.Point3d, nxopen.TaggedObject)

Created in NX7.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PlacePartBuilder.LoadedPartInfoData This class holds the data returned from getLoadedPartInfo()

Method Summary

Modifier and Type	Method and Description
void	finalizePlacement(CharacteristicList optionalCharx, CharacteristicList requiredCharx, String name, int layerOption, int layer, boolean dfaultOStock) Complete the placement operation.
boolean	getAddPartToActiveRunFlag() Determines whether part being placed has to be added in active run or not.
PlacePartBuilder.LoadedPartInfoData	getLoadedPartInfo() Get information about the parts being placed.
Vector3d	getScrewSeatAlignmentVector() Gets the alignment vector, primary axis direction for a stock, reducer, elbow, etc. along the part the screw seat is placed to align the screw seat.
Expression	getScrewSeatAngle() Gets the angle expression to be used for screw seat placement along a placed object.
Point3d	getScrewSeatEnd() Gets the point from builder, used in final placement of screw seat.
Point3d	getScrewSeatIntersectionPoint() Gets information about the final screw seat position.
Expression	getScrewSeatLength() Gets the length expression to be used for screw seat placement along a placed object.
void	loadPart() Load the specified part.
void	loadPart(String partNumber) Load a part given the input part number.
void	replaceLoadedInstance(TaggedObject partInst) Replace the builder's part instance with a new instance.
void	setActiveLayer(int layerOption, int layer) Set the layer for the loaded part.
void	setActiveRefSet(String refSet) Set the reference set to use for the loaded part.
void	setAddPartToActiveRunFlag(boolean addPartToActiveRun) Set a flag which tells the builder whether the part being placed will be added in active run or not.
void	setAttributeHolder(AttributeHolder attributeHolder) Sets Attribute holder in builder, which is user for template attribute assignment.
void	setConsiderPorts(boolean considerPorts) Set a flag which will inform the placement solutions builder to consider ports when computing placement solutions during a replace part operation.
void	setItemSelection(int itemSelectionMethod, TaggedObject selectedPartOcc) Set a flag which tells the builder from where the part being placed was selected and the tag of the selected part.
void	setLoadedPartInfo(TaggedObject loadedPart, TaggedObject loadedInst) Get information about the parts being placed.
void	setPlacePartOperation(boolean replacePart) Set a flag which tells the builder whether the part being placed is replacing an existing part in the assembly.
void	setScrewSeatAlignmentVector(Vector3d alignVector) Sets the alignment vector, primary axis direction for a stock, reducer, elbow, etc. along the part the screw seat is placed to align the screw seat.
void	setScrewSeatEnd(Point3d point) Sets a point in builder, which is required for final placement of screw seat.
void	setScrewSeatIntersectionPoint(Point3d intersectionPoint) Sets the final position of screw seat.
void	setScrewSeatPlacement(TaggedObject startLocation, TaggedObject endLocation, Point3d startPoint, Point3d endPoint, Expression length, Expression angle) Sets the input parameters to be used for measurement holder screw seats.
void	unloadPart() Update the loaded part with a new placement location and object.
void	updatePlacementObj(TaggedObject placementObj, Point3d placementPos) Update the loaded part with a new placement location and object.
void	updateRoutingTemplateAttributes() Updates the Routing Template Attributes to AttributeHolder License requirements: routing_base ("Routing Basic") .

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

loadPart

void loadPart(String partNumber)
       throws NXException,
              RemoteException

Load a part given the input part number.
License requirements: routing_base ("Routing Basic")

Created in NX7.5.0

Parameters:

partNumber - Part number

Throws:

NXException

RemoteException

loadPart

void loadPart()
       throws NXException,
              RemoteException

Load the specified part.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Throws:

NXException

RemoteException

setActiveRefSet

void setActiveRefSet(String refSet)
              throws NXException,
                     RemoteException

Set the reference set to use for the loaded part.
License requirements: routing_base ("Routing Basic")

Created in NX7.5.0

Parameters:

refSet - Reference Set Name

Throws:

NXException

RemoteException

setActiveLayer

void setActiveLayer(int layerOption,
                    int layer)
             throws NXException,
                    RemoteException

Set the layer for the loaded part.
License requirements: routing_base ("Routing Basic")

Created in NX7.5.0

Parameters:

layerOption - Layer Option

layer - Layer Number

Throws:

NXException

RemoteException

setScrewSeatPlacement

void setScrewSeatPlacement(TaggedObject startLocation,
                           TaggedObject endLocation,
                           Point3d startPoint,
                           Point3d endPoint,
                           Expression length,
                           Expression angle)
                    throws NXException,
                           RemoteException

Sets the input parameters to be used for measurement holder screw seats.
License requirements: routing_base ("Routing Basic")

Created in NX10.0.0

Parameters:

startLocation - The start port to determine screw seat placement.

endLocation - The end port to determine screw seat placement.

startPoint - The start position to determine screw seat placement.

endPoint - The end position to determine screw seat placement.

length - The length along the axis to place screw seat.

angle - The angle along the axis to place screw seat.

Throws:

NXException

RemoteException

finalizePlacement

void finalizePlacement(CharacteristicList optionalCharx,
                       CharacteristicList requiredCharx,
                       String name,
                       int layerOption,
                       int layer,
                       boolean dfaultOStock)
                throws NXException,
                       RemoteException

Complete the placement operation.
License requirements: routing_base ("Routing Basic")

Created in NX7.5.0

Parameters:

optionalCharx - Optional Charx to apply.

requiredCharx - Required Charx to apply.

name - The component name to apply to the part.

layerOption - The layer option.

layer - The layer to apply.

dfaultOStock - Assign overstock to a fitting when a default is defined.

Throws:

NXException

RemoteException

updatePlacementObj

void updatePlacementObj(TaggedObject placementObj,
                        Point3d placementPos)
                 throws NXException,
                        RemoteException

Update the loaded part with a new placement location and object.
License requirements: routing_base ("Routing Basic")

Created in NX7.5.0

Parameters:

placementObj - New object to attach to. Can bee NULL.

placementPos - The new location for the part.

Throws:

NXException

RemoteException

unloadPart

void unloadPart()
         throws NXException,
                RemoteException

Update the loaded part with a new placement location and object.
License requirements: routing_base ("Routing Basic")

Created in NX7.5.0

Throws:

NXException

RemoteException

getLoadedPartInfo

PlacePartBuilder.LoadedPartInfoData getLoadedPartInfo()
                                               throws NXException,
                                                      RemoteException

Get information about the parts being placed.
License requirements: routing_base ("Routing Basic")

Created in NX7.5.0

Throws:

NXException

RemoteException

setLoadedPartInfo

void setLoadedPartInfo(TaggedObject loadedPart,
                       TaggedObject loadedInst)
                throws NXException,
                       RemoteException

Get information about the parts being placed.
License requirements: routing_base ("Routing Basic")

Created in NX7.5.0

Parameters:

loadedPart - The PART object of the loaded part.

loadedInst - The Instance object of the loaded part.

Throws:

NXException

RemoteException

replaceLoadedInstance

void replaceLoadedInstance(TaggedObject partInst)
                    throws NXException,
                           RemoteException

Replace the builder's part instance with a new instance. This is used when the assemblies absolute positioning method is used. It will create it's own part instance and we need make sure the builder has the new one.
License requirements: routing_base ("Routing Basic")

Created in NX7.5.0

Parameters:

partInst - The instance object of the loaded part.

Throws:

NXException

RemoteException

setPlacePartOperation

void setPlacePartOperation(boolean replacePart)
                    throws NXException,
                           RemoteException

Set a flag which tells the builder whether the part being placed is replacing an existing part in the assembly.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Parameters:

replacePart - True if replace part operation.

Throws:

NXException

RemoteException

setScrewSeatIntersectionPoint

void setScrewSeatIntersectionPoint(Point3d intersectionPoint)
                            throws NXException,
                                   RemoteException

Sets the final position of screw seat. This is required in builder when doing finalize placement after (OK/Apply) .
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Parameters:

intersectionPoint - The final position of screw seat placement.

Throws:

NXException

RemoteException

getScrewSeatIntersectionPoint

Point3d getScrewSeatIntersectionPoint()
                               throws NXException,
                                      RemoteException

Gets information about the final screw seat position.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Returns:

The final position of screw seat placement.

Throws:

NXException

RemoteException

setScrewSeatAlignmentVector

void setScrewSeatAlignmentVector(Vector3d alignVector)
                          throws NXException,
                                 RemoteException

Sets the alignment vector, primary axis direction for a stock, reducer, elbow, etc. along the part the screw seat is placed to align the screw seat. Optional, otherwise an arbitrary vector will be constructed.
License requirements: routing_base ("Routing Basic")

Created in NX10.0.0

Parameters:

alignVector - The alignment vector along the part on which screw seat is placed.

Throws:

NXException

RemoteException

getScrewSeatAlignmentVector

Vector3d getScrewSeatAlignmentVector()
                              throws NXException,
                                     RemoteException

Gets the alignment vector, primary axis direction for a stock, reducer, elbow, etc. along the part the screw seat is placed to align the screw seat. Optional, otherwise an arbitrary vector will be constructed.
License requirements: routing_base ("Routing Basic")

Created in NX10.0.0

Returns:

The alignment vector along the part on which screw seat is placed.

Throws:

NXException

RemoteException

setScrewSeatEnd

void setScrewSeatEnd(Point3d point)
              throws NXException,
                     RemoteException

Sets a point in builder, which is required for final placement of screw seat. This point is used for creating segments / constraints when finally placing the screw seat.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Parameters:

point - This is the internal point used in determining final position of screw seat placement.

Throws:

NXException

RemoteException

getScrewSeatEnd

Point3d getScrewSeatEnd()
                 throws NXException,
                        RemoteException

Gets the point from builder, used in final placement of screw seat. This point is used for creating segemnts / constraints when finally placing the screw seat.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Returns:

This is the internal point used in determining final position of screw seat placement.

Throws:

NXException

RemoteException

setAttributeHolder

void setAttributeHolder(AttributeHolder attributeHolder)
                 throws NXException,
                        RemoteException

Sets Attribute holder in builder, which is user for template attribute assignment.
License requirements: routing_base ("Routing Basic")

Created in NX8.5.0

Parameters:

attributeHolder - Object to hold template attributes

Throws:

NXException

RemoteException

getAddPartToActiveRunFlag

boolean getAddPartToActiveRunFlag()
                           throws NXException,
                                  RemoteException

Determines whether part being placed has to be added in active run or not.
License requirements: routing_base ("Routing Basic")

Created in NX10.0.0

Throws:

NXException

RemoteException

setAddPartToActiveRunFlag

void setAddPartToActiveRunFlag(boolean addPartToActiveRun)
                        throws NXException,
                               RemoteException

Set a flag which tells the builder whether the part being placed will be added in active run or not.
License requirements: routing_base ("Routing Basic")

Created in NX10.0.0

Parameters:

addPartToActiveRun -

Throws:

NXException

RemoteException

getScrewSeatLength

Expression getScrewSeatLength()
                       throws NXException,
                              RemoteException

Gets the length expression to be used for screw seat placement along a placed object.
License requirements: routing_base ("Routing Basic")

Created in NX10.0.0

Returns:

The length used for screw seat placement on placed routing object.

Throws:

NXException

RemoteException

getScrewSeatAngle

Expression getScrewSeatAngle()
                      throws NXException,
                             RemoteException

Gets the angle expression to be used for screw seat placement along a placed object.
License requirements: routing_base ("Routing Basic")

Created in NX10.0.0

Returns:

The angle used for screw seat placement on placed routing object.

Throws:

NXException

RemoteException

setItemSelection

void setItemSelection(int itemSelectionMethod,
                      TaggedObject selectedPartOcc)
               throws NXException,
                      RemoteException

Set a flag which tells the builder from where the part being placed was selected and the tag of the selected part.
License requirements: routing_base ("Routing Basic")

Created in NX11.0.0

Parameters:

itemSelectionMethod - The enum representing the way of selection of part to be placed.

selectedPartOcc - The tag of the part occurrence selected from specify item dialog.

Throws:

NXException

RemoteException

updateRoutingTemplateAttributes

void updateRoutingTemplateAttributes()
                              throws NXException,
                                     RemoteException

Updates the Routing Template Attributes to AttributeHolder
License requirements: routing_base ("Routing Basic")
.
Created in NX11.0.0

Throws:

NXException

RemoteException

setConsiderPorts

void setConsiderPorts(boolean considerPorts)
               throws NXException,
                      RemoteException

Set a flag which will inform the placement solutions builder to consider ports when computing placement solutions during a replace part operation. Setting this to false implies that the first placement solution computed is to maintain the origin and orientation of the part being replaced. Setting this to true implies that the first placement solution computed is to maintain the location of the original part's ports.
License requirements: routing_base ("Routing Basic")

Created in NX11.0.1

Parameters:

considerPorts -

Throws:

NXException

RemoteException