public interface AddComponentBuilder extends Builder, IAttributeSourceObjectBuilder
AssemblyManager.createAddComponentBuilder()
Modifier and Type | Interface and Description |
---|---|
static class |
AddComponentBuilder.InitialLocationAndOrientationData
This class holds the data returned from
getInitialLocationAndOrientation() |
static class |
AddComponentBuilder.LocationType
Represents initial location type that can be present during add component
|
Modifier and Type | Method and Description |
---|---|
String |
componentName()
Returns the component name for added components.
|
String |
designElementType()
Returns the type of a add component
License requirements: None. |
FileNew |
fileNewDescriptor()
Returns the file new descriptor to identify an added component in 4GD
License requirements: None. |
InterfaceObject[] |
getAllProductInterfaceObjects()
Returns all product interface objects available, one of these can be used as component anchor
License requirements: None. |
InterfaceObject |
getComponentAnchor()
Returns the component anchor used for adding component
License requirements: None. |
int |
getCount()
Gets the number of components to be added.
|
AddComponentBuilder.InitialLocationAndOrientationData |
getInitialLocationAndOrientation()
Returns the location and orientation used for adding component
License requirements: None. |
AddComponentBuilder.LocationType |
getInitialLocationType()
Get the initial location type during add component.
|
boolean |
getKeepConstraintsOption()
Gets the keep constraints option for added components.
|
LogicalObject[] |
getLogicalObjects()
Returns the pre-creation objects
License requirements: None. |
LogicalObject[] |
getLogicalObjectsHavingUnassignedRequiredAttributes()
Returns the pre-creation objects which have unassign required attributes
License requirements: None. |
ErrorList |
getOperationFailures()
Returns add component operation failures
License requirements: None. |
BasePart[] |
getPartsToAdd()
Returns the parts to be used for adding components
License requirements: None. |
boolean |
getScatterOption()
Gets the scatter option for added components.
|
int |
layer()
Returns the layer for added components.
|
void |
orientToWCS()
Orient added components to the WCS
License requirements: assemblies ("ASSEMBLIES MODULE") . |
String |
referenceSet()
Returns the reference set for added components.
|
void |
removeAddedComponents()
Removes the components added through add component
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
resetToSnapped()
Resets the component to snapped position and orientation
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
reverseZDirection()
Reverse the Z direction of added components
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
rotateAlongZDirection()
Rotate added components along Z direction by 90 degrees
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
setComponentAnchor(InterfaceObject componentAnchor)
Sets the component anchor to be used for adding component
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
setComponentName(String componentName)
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
setCount(int count)
Sets the number of components to be added.
|
void |
setDesignElementType(String deType)
License requirements: nx_4gd_integration ("4th Generation Design") . |
void |
setInitialLocationAndOrientation(Point3d point,
Matrix3x3 orientation)
Sets the location and orientation to be used for add component.
|
void |
setInitialLocationAndOrientation(Point initialLocation,
CoordinateSystem initialOrientation)
Sets the location and orientation to be used for adding component.
|
void |
setInitialLocationType(AddComponentBuilder.LocationType locationType)
Set the initial location type during add component.
|
void |
setKeepConstraintsOption(boolean keepConstraintsOption)
Sets the keep constraints option for added components.
|
void |
setLayer(int layer)
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
setPartsToAdd(BasePart[] partsToUse)
Sets the parts to be used for adding components
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
setReferenceSet(String referenceSet)
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
setScatterOption(boolean scatterOption)
Sets the scatter option for added components.
|
void |
setSynchDisplayProperties(boolean synchDisplayProperties)
Sets the option to synchronize display properties with the component to be added
License requirements: assemblies ("ASSEMBLIES MODULE") . |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
autoAssignAttributes, autoAssignAttributesWithNamingPattern, createAttributeTitleToNamingPatternMap
String designElementType() throws NXException, RemoteException
NXException
RemoteException
void setDesignElementType(String deType) throws NXException, RemoteException
deType
- NXException
RemoteException
String componentName() throws NXException, RemoteException
NXException
RemoteException
void setComponentName(String componentName) throws NXException, RemoteException
componentName
- NXException
RemoteException
String referenceSet() throws NXException, RemoteException
NXException
RemoteException
void setReferenceSet(String referenceSet) throws NXException, RemoteException
referenceSet
- NXException
RemoteException
int layer() throws NXException, RemoteException
NXException
RemoteException
void setLayer(int layer) throws NXException, RemoteException
layer
- NXException
RemoteException
BasePart[] getPartsToAdd() throws NXException, RemoteException
NXException
RemoteException
void setPartsToAdd(BasePart[] partsToUse) throws NXException, RemoteException
partsToUse
- NXException
RemoteException
void removeAddedComponents() throws NXException, RemoteException
NXException
RemoteException
FileNew fileNewDescriptor() throws NXException, RemoteException
NXException
RemoteException
int getCount() throws NXException, RemoteException
NXException
RemoteException
void setCount(int count) throws NXException, RemoteException
count
- NXException
RemoteException
AddComponentBuilder.LocationType getInitialLocationType() throws NXException, RemoteException
NXException
RemoteException
void setInitialLocationType(AddComponentBuilder.LocationType locationType) throws NXException, RemoteException
locationType
- NXException
RemoteException
AddComponentBuilder.InitialLocationAndOrientationData getInitialLocationAndOrientation() throws NXException, RemoteException
NXException
RemoteException
void setInitialLocationAndOrientation(Point initialLocation, CoordinateSystem initialOrientation) throws NXException, RemoteException
initialLocation
- initialOrientation
- NXException
RemoteException
void setInitialLocationAndOrientation(Point3d point, Matrix3x3 orientation) throws NXException, RemoteException
point
- orientation
- NXException
RemoteException
boolean getScatterOption() throws NXException, RemoteException
NXException
RemoteException
void setScatterOption(boolean scatterOption) throws NXException, RemoteException
scatterOption
- NXException
RemoteException
boolean getKeepConstraintsOption() throws NXException, RemoteException
NXException
RemoteException
void setKeepConstraintsOption(boolean keepConstraintsOption) throws NXException, RemoteException
keepConstraintsOption
- NXException
RemoteException
InterfaceObject getComponentAnchor() throws NXException, RemoteException
NXException
RemoteException
void setComponentAnchor(InterfaceObject componentAnchor) throws NXException, RemoteException
componentAnchor
- NXException
RemoteException
InterfaceObject[] getAllProductInterfaceObjects() throws NXException, RemoteException
NXException
RemoteException
LogicalObject[] getLogicalObjects() throws NXException, RemoteException
NXException
RemoteException
LogicalObject[] getLogicalObjectsHavingUnassignedRequiredAttributes() throws NXException, RemoteException
NXException
RemoteException
ErrorList getOperationFailures() throws NXException, RemoteException
NXException
RemoteException
void resetToSnapped() throws NXException, RemoteException
NXException
RemoteException
void orientToWCS() throws NXException, RemoteException
NXException
RemoteException
void reverseZDirection() throws NXException, RemoteException
NXException
RemoteException
void rotateAlongZDirection() throws NXException, RemoteException
NXException
RemoteException
void setSynchDisplayProperties(boolean synchDisplayProperties) throws NXException, RemoteException
synchDisplayProperties
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.