public interface Subset extends NXObject
SubsetBuilder
Modifier and Type | Interface and Description |
---|---|
static class |
Subset.ContentType
Represents the content type for a subset.
|
static class |
Subset.PartitionViewStyleType
Represents the type of partition view style to show for a subset.
|
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
void |
addAllChildrenToSubset(Component[] reuseDesignElements)
Adds all the child components of the selected Reuse Design Element to the owning subset.
|
void |
addConnectedByElements()
Add Elements to a subset that reference the existing Design Elements in it by a Connection relation.
|
PartLoadStatus |
addDesignElementsToSubset(ModelElementRevision[] designElements)
Adds the specified
ModelElementRevision s as members of the subset. |
void |
addInterpartParents()
Add sources of interpart relationships (wave links in the subset and Connected To relationships for design features)
that are not in the specified subset to the subset recipe.
|
void |
addNewChildrenToSubset()
If the Reuse Design Elements in the subset contain any new components which were not added
to the subset because its owning workset was not the displayed part at the time of creation,
then add those new components to the subset now.
|
boolean |
allowMultipleTargetPartitions()
Returns
the allow multiple target partitions property, if set to false (default) only first target partition will be considered
License requirements: nx_4gd_integration ("4th Generation Design") . |
boolean |
canReplaceContentDefinition(ContentDefinition contentDefinition)
Checks if the
ContentDefinition object on the Subset can be replaced with the specified ContentDefinition object. |
Component |
componentInWorkset()
Returns the
Component that corresponds to this subset in
the workset ComponentAssembly . |
void |
deleteFromCollaborativeDesign(NXObject[] designElement)
Deletes the design elements from the owning
CollaborativeDesign . |
void |
deletePositioningTask(PositioningTask positioningTask)
Deletes the
PositioningTask from this subset. |
String |
description()
Returns the description of this subset.
|
boolean |
displayExcludedDesignElements()
Returns the design elements excluded from spatial search to be displayed or not
License requirements: nx_4gd_integration ("4th Generation Design") . |
PositioningTask[] |
getAllPositioningTasks()
Gets all
PositioningTask
that belong to this subset. |
DesignElementRevision[] |
getDesignElementRevisionMembers()
The
DesignElementRevision s that are members of this subset. |
DesignElementRevision[] |
getDesignElementRevisionParents()
The
DesignElementRevision s that have been loaded because they contain
a DesignSubordinateRevision that belongs to this subset. |
DesignSubordinateRevision[] |
getDesignSubordinateRevisionMembers()
The
DesignSubordinateRevision s that are members of this subset. |
DesignSubordinateRevision[] |
getDesignSubordinateRevisionParents()
The
DesignSubordinateRevision s that have been loaded because they contain
a DesignSubordinateRevision that belongs to this subset. |
Partition[] |
getTargetPartitionSet()
Gets the list of array of target partitions that are set on the subsetInstance
License requirements: nx_4gd_integration ("4th Generation Design") . |
void |
hideCollaborativeDesignPreview()
Hides the preview for the Collaborative Design in the graphics window if it was
already displayed.
|
boolean |
isCollaborativeDesignPreviewDisplayed()
Is the preview for the Collaborative Design being displayed in the Graphics window.
|
Subset.PartitionViewStyleType |
partitionViewStyle()
Returns
the partition view style to show.
|
void |
removeDesignElements(NXObject[] designElements)
Removes the design elements from this subset.
|
void |
replaceContentDefinition(ContentDefinition contentDefinition)
Replace the
ContentDefinition object on the Subset. |
void |
replayRecipe()
Replay this subset.
|
void |
setAllowMultipleTargetPartitions(boolean allowMultiplePartitions)
License requirements: nx_4gd_integration ("4th Generation Design") . |
void |
setContentDefinition(ContentDefinition contentDefinition)
Set a new
ContentDefinition object on the Subset. |
void |
setDisplayExcludedDesignElements(boolean displayExcluded)
License requirements: nx_4gd_integration ("4th Generation Design") . |
void |
setPartitionViewStyle(Subset.PartitionViewStyleType partitionViewStyle)
License requirements: nx_4gd_integration ("4th Generation Design") . |
void |
setShowSubsetStructure(boolean showSubsetStructure)
License requirements: nx_4gd_integration ("4th Generation Design") . |
void |
setTargetPartitionSet(Partition[] partitions)
Sets the list of array of target partitions on the subsetInstance
License requirements: nx_4gd_integration ("4th Generation Design") . |
boolean |
showCollaborativeDesignPreview()
Displays the preview for the Collaborative Design in the graphics window.
|
boolean |
showSubsetStructure()
Returns
the subset structure to be shown or not.
|
Subset.ContentType |
subsetType()
Returns the type of plm object used to create subset.
|
createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
String description() throws NXException, RemoteException
NXException
RemoteException
void replayRecipe() throws NXException, RemoteException
NXException
RemoteException
Component componentInWorkset() throws NXException, RemoteException
Component
that corresponds to this subset in
the workset ComponentAssembly
.
NXException
RemoteException
void removeDesignElements(NXObject[] designElements) throws NXException, RemoteException
CollaborativeDesign
.
designElements
- NXException
RemoteException
void deleteFromCollaborativeDesign(NXObject[] designElement) throws NXException, RemoteException
CollaborativeDesign
.
designElement
- NXException
RemoteException
void addInterpartParents() throws NXException, RemoteException
NXException
RemoteException
void addConnectedByElements() throws NXException, RemoteException
addInterpartParents()
"
NXException
RemoteException
void addAllChildrenToSubset(Component[] reuseDesignElements) throws NXException, RemoteException
reuseDesignElements
- NXException
RemoteException
void addNewChildrenToSubset() throws NXException, RemoteException
NXException
RemoteException
DesignElementRevision[] getDesignElementRevisionMembers() throws NXException, RemoteException
DesignElementRevision
s that are members of this subset.
Note that this does not include elements that have been loaded only because they contain
a DesignSubordinateRevision
that belongs to this subset.
See getDesignElementRevisionParents()
NXException
RemoteException
DesignElementRevision[] getDesignElementRevisionParents() throws NXException, RemoteException
DesignElementRevision
s that have been loaded because they contain
a DesignSubordinateRevision
that belongs to this subset.
NXException
RemoteException
DesignSubordinateRevision[] getDesignSubordinateRevisionMembers() throws NXException, RemoteException
DesignSubordinateRevision
s that are members of this subset.
Note that this does not include elements that have been loaded only because they contain
a DesignSubordinateRevision
that belongs to this subset.
See getDesignSubordinateRevisionParents()
NXException
RemoteException
DesignSubordinateRevision[] getDesignSubordinateRevisionParents() throws NXException, RemoteException
DesignSubordinateRevision
s that have been loaded because they contain
a DesignSubordinateRevision
that belongs to this subset.
NXException
RemoteException
boolean showCollaborativeDesignPreview() throws NXException, RemoteException
hideCollaborativeDesignPreview()
.
NXException
RemoteException
void hideCollaborativeDesignPreview() throws NXException, RemoteException
showCollaborativeDesignPreview()
.
NXException
RemoteException
boolean isCollaborativeDesignPreviewDisplayed() throws NXException, RemoteException
NXException
RemoteException
boolean displayExcludedDesignElements() throws NXException, RemoteException
NXException
RemoteException
void setDisplayExcludedDesignElements(boolean displayExcluded) throws NXException, RemoteException
displayExcluded
- NXException
RemoteException
Subset.PartitionViewStyleType partitionViewStyle() throws NXException, RemoteException
NXException
RemoteException
void setPartitionViewStyle(Subset.PartitionViewStyleType partitionViewStyle) throws NXException, RemoteException
partitionViewStyle
- NXException
RemoteException
boolean allowMultipleTargetPartitions() throws NXException, RemoteException
NXException
RemoteException
void setAllowMultipleTargetPartitions(boolean allowMultiplePartitions) throws NXException, RemoteException
allowMultiplePartitions
- NXException
RemoteException
Partition[] getTargetPartitionSet() throws NXException, RemoteException
NXException
RemoteException
void setTargetPartitionSet(Partition[] partitions) throws NXException, RemoteException
partitions
- NXException
RemoteException
boolean showSubsetStructure() throws NXException, RemoteException
NXException
RemoteException
void setShowSubsetStructure(boolean showSubsetStructure) throws NXException, RemoteException
showSubsetStructure
- NXException
RemoteException
PositioningTask[] getAllPositioningTasks() throws NXException, RemoteException
PositioningTask
that belong to this subset.
NXException
RemoteException
void deletePositioningTask(PositioningTask positioningTask) throws NXException, RemoteException
PositioningTask
from this subset.
positioningTask
- NXException
RemoteException
void setContentDefinition(ContentDefinition contentDefinition) throws NXException, RemoteException
ContentDefinition
object on the Subset.
contentDefinition
- NXException
RemoteException
void replaceContentDefinition(ContentDefinition contentDefinition) throws NXException, RemoteException
ContentDefinition
object on the Subset.
contentDefinition
- NXException
RemoteException
boolean canReplaceContentDefinition(ContentDefinition contentDefinition) throws NXException, RemoteException
ContentDefinition
object on the Subset can be replaced with the specified ContentDefinition
object.
contentDefinition
- NXException
RemoteException
Subset.ContentType subsetType() throws NXException, RemoteException
NXException
RemoteException
PartLoadStatus addDesignElementsToSubset(ModelElementRevision[] designElements) throws NXException, RemoteException
ModelElementRevision
s as members of the subset.
The subset recipe will be edited to include these elements with explicit include terms.
A replay of the entire recipe will not be performed. The specified elements will be appended to the
subset.
See replayRecipe()
designElements
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.