SubsetBuilder Class¶

class NXOpen.Assemblies.SubsetBuilder¶

Bases: NXOpen.Builder, NXOpen.IAttributeSourceObjectBuilder

A SubsetBuilder is used to create or edit an NXOpen.Assemblies.Subset.

To create a new instance of this class, use NXOpen.Assemblies.SubsetCollection.CreateSubsetBuilder()

New in version NX8.5.0.

Properties¶

Property	Description
AddAllSubordinates	Returns or sets the value which determines whether the subset will include all the subordinates of reuse design elements.
CollaborativeDesign	Returns or sets the `NXOpen.CollaborativeDesign` of the subset.
ConfigurationContext	Returns the configuration context builder.
ContentDefinition	Returns or sets the `NXOpen.ContentDefinition` used to define the context of the subset creation.
Finder	Returns the `NXOpen.Assemblies.FindInCollaborativeDesign` for use in the context determined by this builder.
Subset	Returns the `NXOpen.Assemblies.Subset` that we are building.
SubsetConfiguration	Returns the subset configuration.
SubsetDescription	Returns or sets the description of the `NXOpen.Assemblies.Subset`.
SubsetName	Returns or sets the name of the `NXOpen.Assemblies.Subset`.
SubsetType	Returns the type of PLM object used to create subset.
Tag	Returns the Tag for this object.
TargetEffectivity	Returns the `NXOpen.BasicEffectivityBuilder` used to edit the target effectivity of the subset.
TargetEffectivityTable	Returns the `NXOpen.PDM.EffectivityTableBuilder` used to edit the target effectivity of the subset.
TargetPartitionList	Returns the default target :py:class:`NXOpen.Assemblies.Partition`s for design elements created within the subset.
ViewedPartitionScheme	Returns or sets the viewed `NXOpen.Assemblies.PartitionScheme` of the subset.
Workset	Returns the `NXOpen.Assemblies.ComponentAssembly` within which we are building an `NXOpen.Assemblies.Subset`.
SearchResults	Returns the <ja_class>NXOpen.Assemblies.SearchResultCollection</ja_class> that contains current search results associated with this subset builder. SearchResults will be populated with the existing subset contents when the builder is created to edit a subset. These are replaced with results found by the last call to <ja_method>SubsetBuilder.GenerateResults</ja_method> after that method is first called. In addition, the last results from <ja_property_get>SubsetBuilder.Finder</ja_property_get> are included in this collection.
Recipe	Returns the <ja_class>NXOpen.Assemblies.SubsetRecipe</ja_class> that contains the <ja_class>NXOpen.Assemblies.SearchTerm</ja_class>s used to generate the contents of the subset

Methods¶

Method	Description
AutoAssignAttributes	Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
FindObject	Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.
GenerateResults	Generate the search results for the `NXOpen.Assemblies.Subset` according to the current `NXOpen.Assemblies.SubsetRecipe`.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
GetSubsetLogicalObjects	Returns subset logical objects created by builder.
GetSubsets	Returns subsets held / created by this builder.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateConfigurationContext	Updates revision rule, effectivity and variant information on subset logical object of subset builder.
UpdateSubsetConfigurationOfDependentSubset	Updates revision rule, effectivity information on the dependent subsets if any.
UpdateSubsetTargetPropertiesOfDependentSubset	Updates target effectivity information on the dependent subsets if any.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail¶

AddAllSubordinates¶

SubsetBuilder.AddAllSubordinates¶

Returns or sets the value which determines whether the subset will include all the subordinates of reuse design elements.

-------------------------------------

Getter Method

Signature AddAllSubordinates()

Returns:
Return type:	bool

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

-------------------------------------

Setter Method

Signature AddAllSubordinates(addAllSubordinates)

Parameters:	addAllSubordinates (bool) –

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

CollaborativeDesign¶

SubsetBuilder.CollaborativeDesign¶

Returns or sets the NXOpen.CollaborativeDesign of the subset.

-------------------------------------

Getter Method

Signature CollaborativeDesign()

Returns:
Return type:	`NXOpen.CollaborativeDesign`

New in version NX8.5.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

-------------------------------------

Setter Method

Signature CollaborativeDesign(collaborativeDesign)

Parameters:	collaborativeDesign (`NXOpen.CollaborativeDesign`) –

New in version NX8.5.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

ConfigurationContext¶

SubsetBuilder.ConfigurationContext¶

Returns the configuration context builder.

-------------------------------------

Getter Method

Signature ConfigurationContext()

Returns:
Return type:	`NXOpen.PDM.ConfigurationContextBuilder`

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

ContentDefinition¶

SubsetBuilder.ContentDefinition¶

Returns or sets the NXOpen.ContentDefinition used to define the context of the subset creation.

-------------------------------------

Getter Method

Signature ContentDefinition()

Returns:
Return type:	`NXOpen.ContentDefinition`

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

-------------------------------------

Setter Method

Signature ContentDefinition(contentDefinition)

Parameters:	contentDefinition (`NXOpen.ContentDefinition`) –

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Finder¶

SubsetBuilder.Finder¶

Returns the NXOpen.Assemblies.FindInCollaborativeDesign for use in the context determined by this builder.

-------------------------------------

Getter Method

Signature Finder()

Returns:
Return type:	`NXOpen.Assemblies.FindInCollaborativeDesign`

New in version NX8.5.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Subset¶

SubsetBuilder.Subset¶

Returns the NXOpen.Assemblies.Subset that we are building.

-------------------------------------

Getter Method

Signature Subset()

Returns:
Return type:	`NXOpen.Assemblies.Subset`

New in version NX8.5.0.

Deprecated since version NX11.0.0: Please use NXOpen.Assemblies.SubsetBuilder.GetSubsets() instead.

License requirements: nx_4gd_integration (“4th Generation Design”)

SubsetConfiguration¶

SubsetBuilder.SubsetConfiguration¶

Returns the subset configuration.

-------------------------------------

Getter Method

Signature SubsetConfiguration()

Returns:
Return type:	`NXOpen.Assemblies.SubsetConfigurationBuilder`

New in version NX8.5.0.

Deprecated since version NX9.0.0: Use NXOpen.Assemblies.SubsetBuilder.ConfigurationContext() instead.

License requirements: nx_4gd_integration (“4th Generation Design”)

SubsetDescription¶

SubsetBuilder.SubsetDescription¶

Returns or sets the description of the NXOpen.Assemblies.Subset.

-------------------------------------

Getter Method

Signature SubsetDescription()

Returns:
Return type:	str

New in version NX8.5.0.

Deprecated since version NX11.0.0: Use NXOpen.PDM.LogicalObject properties instead.

License requirements: nx_4gd_integration (“4th Generation Design”)

-------------------------------------

Setter Method

Signature SubsetDescription(description)

Parameters:	description (str) –

New in version NX8.5.0.

Deprecated since version NX11.0.0: Use NXOpen.PDM.LogicalObject properties instead.

License requirements: nx_4gd_integration (“4th Generation Design”)

SubsetName¶

SubsetBuilder.SubsetName¶

Returns or sets the name of the NXOpen.Assemblies.Subset.

-------------------------------------

Getter Method

Signature SubsetName()

Returns:
Return type:	str

New in version NX8.5.0.

Deprecated since version NX11.0.0: Use NXOpen.PDM.LogicalObject properties instead.

License requirements: nx_4gd_integration (“4th Generation Design”)

-------------------------------------

Setter Method

Signature SubsetName(name)

Parameters:	name (str) –

New in version NX8.5.0.

Deprecated since version NX11.0.0: Use NXOpen.PDM.LogicalObject properties instead.

License requirements: nx_4gd_integration (“4th Generation Design”)

SubsetType¶

SubsetBuilder.SubsetType¶

Returns the type of PLM object used to create subset.

-------------------------------------

Getter Method

Signature SubsetType()

Returns:
Return type:	`NXOpen.Assemblies.SubsetContentType`

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

TargetEffectivity¶

SubsetBuilder.TargetEffectivity¶

Returns the NXOpen.BasicEffectivityBuilder used to edit the target effectivity of the subset.

-------------------------------------

Getter Method

Signature TargetEffectivity()

Returns:
Return type:	`NXOpen.BasicEffectivityBuilder`

New in version NX8.5.0.

Deprecated since version NX9.0.0: Use SubsetBuilder.TargetEffectivityTable() instead.

License requirements: nx_4gd_integration (“4th Generation Design”)

TargetEffectivityTable¶

SubsetBuilder.TargetEffectivityTable¶

Returns the NXOpen.PDM.EffectivityTableBuilder used to edit the target effectivity of the subset.

-------------------------------------

Getter Method

Signature TargetEffectivityTable()

Returns:
Return type:	`NXOpen.PDM.EffectivityTableBuilder`

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

TargetPartitionList¶

SubsetBuilder.TargetPartitionList¶

Returns the default target :py:class:`NXOpen.Assemblies.Partition`s for design elements created within the subset.

-------------------------------------

Getter Method

Signature TargetPartitionList()

Returns:
Return type:	`NXOpen.Assemblies.PartitionList`

New in version NX8.5.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

ViewedPartitionScheme¶

SubsetBuilder.ViewedPartitionScheme¶

Returns or sets the viewed NXOpen.Assemblies.PartitionScheme of the subset.

-------------------------------------

Getter Method

Signature ViewedPartitionScheme()

Returns:
Return type:	`NXOpen.Assemblies.PartitionScheme`

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

-------------------------------------

Setter Method

Signature ViewedPartitionScheme(partitionScheme)

Parameters:	partitionScheme (`NXOpen.Assemblies.PartitionScheme`) –

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Workset¶

SubsetBuilder.Workset¶

Returns the NXOpen.Assemblies.ComponentAssembly within which we are building an NXOpen.Assemblies.Subset.

-------------------------------------

Getter Method

Signature Workset()

Returns:
Return type:	`NXOpen.Assemblies.ComponentAssembly`

New in version NX8.5.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

SearchResults¶

SubsetBuilder.SearchResults¶

Returns the NXOpen.Assemblies.SearchResultCollection that contains current search results associated with this subset builder.

SearchResults will be populated with the existing subset contents when the builder is created to edit a subset. These are replaced with results found by the last call to SubsetBuilder.GenerateResults() after that method is first called. In addition, the last results from SubsetBuilder.Finder() are included in this collection.

Signature SearchResults()

New in version NX8.5.0.

Returns:
Return type:	`NXOpen.Assemblies.SearchResultCollection`

Recipe¶

SubsetBuilder.Recipe¶

Returns the NXOpen.Assemblies.SubsetRecipe that contains the :py:class:`NXOpen.Assemblies.SearchTerm`s used to generate the contents of the subset

Signature Recipe()

New in version NX8.5.0.

Returns:
Return type:	`NXOpen.Assemblies.SubsetRecipe`

Method Detail¶

AutoAssignAttributes¶

SubsetBuilder.AutoAssignAttributes¶

Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

Signature AutoAssignAttributes(objects)

Parameters:	objects (list of `NXOpen.NXObject`) –
Returns:
Return type:	`NXOpen.ErrorList`

New in version NX8.5.0.

License requirements: None.

FindObject¶

SubsetBuilder.FindObject¶

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:	journalIdentifier (str) – Identifier of the `NXOpen.NXObject` to be found
Returns:	Object found, or null if no such object exists
Return type:	`NXOpen.NXObject`

New in version NX8.5.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

GenerateResults¶

SubsetBuilder.GenerateResults¶

Generate the search results for the NXOpen.Assemblies.Subset according to the current NXOpen.Assemblies.SubsetRecipe.

Signature GenerateResults()

New in version NX8.5.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

GetSubsetLogicalObjects¶

SubsetBuilder.GetSubsetLogicalObjects¶

Returns subset logical objects created by builder.

Signature GetSubsetLogicalObjects()

Returns:
Return type:	list of `NXOpen.PDM.LogicalObject`

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

GetSubsets¶

SubsetBuilder.GetSubsets¶

Returns subsets held / created by this builder.

Signature GetSubsets()

Returns:
Return type:	list of `NXOpen.Assemblies.Subset`

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

UpdateConfigurationContext¶

SubsetBuilder.UpdateConfigurationContext¶

Updates revision rule, effectivity and variant information on subset logical object of subset builder.

Input subset logical object must be member of this subset builder.

Signature UpdateConfigurationContext(logicalObject)

Parameters:	logicalObject (`NXOpen.PDM.LogicalObject`) –

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

UpdateSubsetConfigurationOfDependentSubset¶

SubsetBuilder.UpdateSubsetConfigurationOfDependentSubset¶

Updates revision rule, effectivity information on the dependent subsets if any.

The dependent subset evaluated for the subset represented by the builder.

Signature UpdateSubsetConfigurationOfDependentSubset()

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

UpdateSubsetTargetPropertiesOfDependentSubset¶

SubsetBuilder.UpdateSubsetTargetPropertiesOfDependentSubset¶

Updates target effectivity information on the dependent subsets if any.

The dependent subset evaluated for the subset represented by the builder.

Signature UpdateSubsetTargetPropertiesOfDependentSubset()

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Validate¶

SubsetBuilder.Validate¶

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:	Was self validation successful
Return type:	bool

New in version NX3.0.1.

License requirements: None.