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

Inheritance diagram for NXOpen.Assemblies.SubsetBuilder:

Public Member Functions
unsafe NXOpen.ErrorList	AutoAssignAttributes (NXOpen.NXObject[] objects)
	Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign. More...

unsafe NXOpen.ErrorList	AutoAssignAttributesWithNamingPattern (NXOpen.NXObject[] objects, NXOpen.NXObject[] properties)
	Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. More...

unsafe NXOpen.NXObject	CreateAttributeTitleToNamingPatternMap (string[] attributeTitles, string[] titlePatterns)
	Creates a map object of attribute titles to their corresponding naming pattern More...

unsafe NXOpen.NXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe void	GenerateResults ()
	Generate the search results for the NXOpen.Assemblies.Subset according to the current NXOpen.Assemblies.SubsetRecipe . More...

unsafe void	GetSubsetLogicalObjects (out NXOpen.PDM.LogicalObject[] logicalObjects)
	Returns subset logical objects created by builder. More...

unsafe void	GetSubsets (out NXOpen.Assemblies.Subset[] subsets)
	Returns subsets held / created by this builder. More...

unsafe void	UpdateConfigurationContext (NXOpen.PDM.LogicalObject logicalObject)
	Updates revision rule, effectivity and variant information on subset logical object of subset builder. More...

unsafe void	UpdateSubsetConfigurationOfDependentSubset ()
	Updates revision rule, effectivity information on the dependent subsets if any. More...

unsafe void	UpdateSubsetTargetPropertiesOfDependentSubset ()
	Updates target effectivity information on the dependent subsets if any. 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...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe bool	AddAllSubordinates `[get, set]`
	Returns or sets the value which determines whether the subset will include all the subordinates of reuse design elements. More...

unsafe NXOpen.CollaborativeDesign	CollaborativeDesign `[get, set]`
	Returns or sets the NXOpen.CollaborativeDesign of the subset. More...

unsafe NXOpen.PDM.ConfigurationContextBuilder	ConfigurationContext `[get]`
	Returns the configuration context builder. More...

unsafe NXOpen.ContentDefinition	ContentDefinition `[get, set]`
	Returns or sets the NXOpen.ContentDefinition used to define the context of the subset creation. More...

unsafe NXOpen.Assemblies.FindInCollaborativeDesign	Finder `[get]`
	Returns the NXOpen.Assemblies.FindInCollaborativeDesign for use in the context determined by this builder. More...

NXOpen.Assemblies.SubsetRecipe	Recipe `[get]`
	Returns the NXOpen.Assemblies.SubsetRecipe that contains the NXOpen.Assemblies.SearchTerm s used to generate the contents of the subset More...

NXOpen.Assemblies.SearchResultCollection	SearchResults `[get]`
	Returns the NXOpen.Assemblies.SearchResultCollection that contains current search results associated with this subset builder. More...

unsafe NXOpen.Assemblies.Subset	Subset `[get]`
	Returns the NXOpen.Assemblies.Subset that we are building. More...

unsafe NXOpen.Assemblies.SubsetConfigurationBuilder	SubsetConfiguration `[get]`
	Returns the subset configuration. More...

unsafe string	SubsetDescription `[get, set]`
	Returns or sets the description of the NXOpen.Assemblies.Subset . More...

unsafe string	SubsetName `[get, set]`
	Returns or sets the name of the NXOpen.Assemblies.Subset . More...

unsafe NXOpen.Assemblies.Subset.ContentType	SubsetType `[get]`
	Returns the type of PLM object used to create subset. More...

unsafe NXOpen.PDM.EffectivityTableBuilder	TargetEffectivityTable `[get]`
	Returns the NXOpen.PDM.EffectivityTableBuilder used to edit the target effectivity of the subset. More...

unsafe NXOpen.Assemblies.PartitionList	TargetPartitionList `[get]`
	Returns the default target NXOpen.Assemblies.Partition s for design elements created within the subset. More...

unsafe NXOpen.Assemblies.PartitionScheme	ViewedPartitionScheme `[get, set]`
	Returns or sets the viewed NXOpen.Assemblies.PartitionScheme of the subset. More...

unsafe NXOpen.Assemblies.ComponentAssembly	Workset `[get]`
	Returns the NXOpen.Assemblies.ComponentAssembly within which we are building an NXOpen.Assemblies.Subset . More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

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

Created in NX8.5.0

Member Function Documentation

unsafe NXOpen.ErrorList NXOpen.Assemblies.SubsetBuilder.AutoAssignAttributes ( NXOpen.NXObject[] objects )

inline

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

Created in NX8.5.0

License requirements: None.

Parameters

objects

Returns

Implements NXOpen.IAttributeSourceObjectBuilder.

unsafe NXOpen.ErrorList NXOpen.Assemblies.SubsetBuilder.AutoAssignAttributesWithNamingPattern	(	NXOpen.NXObject[]	objects,
		NXOpen.NXObject[]	properties
	)

inline

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

properties needs to be created using CreateAttributeTitleToNamingPatternMap

Created in NX12.0.0

License requirements: None.

Parameters

objects
properties

Returns

Implements NXOpen.IAttributeSourceObjectBuilder.

unsafe NXOpen.NXObject NXOpen.Assemblies.SubsetBuilder.CreateAttributeTitleToNamingPatternMap	(	string[]	attributeTitles,
		string[]	titlePatterns
	)

inline

Creates a map object of attribute titles to their corresponding naming pattern

Created in NX12.0.0

License requirements: None.

Parameters

attributeTitles
titlePatterns

Returns

Implements NXOpen.IAttributeSourceObjectBuilder.

unsafe NXOpen.NXObject NXOpen.Assemblies.SubsetBuilder.FindObject ( string journalIdentifier )

inline

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.

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

journalIdentifier Identifier of the NXOpen.NXObject to be found

Returns: Object found, or null if no such object exists

unsafe void NXOpen.Assemblies.SubsetBuilder.GenerateResults ( )

inline

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

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

unsafe void NXOpen.Assemblies.SubsetBuilder.GetSubsetLogicalObjects ( out NXOpen.PDM.LogicalObject[] logicalObjects )

inline

Returns subset logical objects created by builder.

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

logicalObjects

unsafe void NXOpen.Assemblies.SubsetBuilder.GetSubsets ( out NXOpen.Assemblies.Subset[] subsets )

inline

Returns subsets held / created by this builder.

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

subsets

unsafe void NXOpen.Assemblies.SubsetBuilder.UpdateConfigurationContext ( NXOpen.PDM.LogicalObject logicalObject )

inline

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.

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

logicalObject

unsafe void NXOpen.Assemblies.SubsetBuilder.UpdateSubsetConfigurationOfDependentSubset ( )

inline

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

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

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

unsafe void NXOpen.Assemblies.SubsetBuilder.UpdateSubsetTargetPropertiesOfDependentSubset ( )

inline

Updates target effectivity information on the dependent subsets if any.

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

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Property Documentation

unsafe bool NXOpen.Assemblies.SubsetBuilder.AddAllSubordinates

getset

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

Created in NX9.0.0

License requirements to get this property: nx_4gd_integration ("4th Generation Design")

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.CollaborativeDesign NXOpen.Assemblies.SubsetBuilder.CollaborativeDesign

getset

Returns or sets the NXOpen.CollaborativeDesign of the subset.

Created in NX8.5.0

License requirements to get this property: nx_4gd_integration ("4th Generation Design")

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.PDM.ConfigurationContextBuilder NXOpen.Assemblies.SubsetBuilder.ConfigurationContext

get

Returns the configuration context builder.

Created in NX9.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.ContentDefinition NXOpen.Assemblies.SubsetBuilder.ContentDefinition

getset

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

Created in NX11.0.0

License requirements to get this property: nx_4gd_integration ("4th Generation Design")

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.FindInCollaborativeDesign NXOpen.Assemblies.SubsetBuilder.Finder

get

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

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

NXOpen.Assemblies.SubsetRecipe NXOpen.Assemblies.SubsetBuilder.Recipe

get

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

Created in NX8.5.0

NXOpen.Assemblies.SearchResultCollection NXOpen.Assemblies.SubsetBuilder.SearchResults

get

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.

Created in NX8.5.0

unsafe NXOpen.Assemblies.Subset NXOpen.Assemblies.SubsetBuilder.Subset

get

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

Created in NX8.5.0

Deprecated in NX11.0.0. Please use NXOpen.Assemblies.SubsetBuilder.GetSubsets instead.

License requirements: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.SubsetConfigurationBuilder NXOpen.Assemblies.SubsetBuilder.SubsetConfiguration

get

Returns the subset configuration.

Created in NX8.5.0

Deprecated in NX9.0.0. Use NXOpen.Assemblies.SubsetBuilder.ConfigurationContext instead.

License requirements: nx_4gd_integration ("4th Generation Design")

unsafe string NXOpen.Assemblies.SubsetBuilder.SubsetDescription

getset

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

Created in NX8.5.0

Deprecated in NX11.0.0. Use NXOpen.PDM.LogicalObject properties instead.

License requirements to get this property: nx_4gd_integration ("4th Generation Design")

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe string NXOpen.Assemblies.SubsetBuilder.SubsetName

getset

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

Created in NX8.5.0

Deprecated in NX11.0.0. Use NXOpen.PDM.LogicalObject properties instead.

License requirements to get this property: nx_4gd_integration ("4th Generation Design")

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.Subset.ContentType NXOpen.Assemblies.SubsetBuilder.SubsetType

get

Returns the type of PLM object used to create subset.

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.PDM.EffectivityTableBuilder NXOpen.Assemblies.SubsetBuilder.TargetEffectivityTable

get

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

Created in NX9.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.PartitionList NXOpen.Assemblies.SubsetBuilder.TargetPartitionList

get

Returns the default target NXOpen.Assemblies.Partition s for design elements created within the subset.

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.PartitionScheme NXOpen.Assemblies.SubsetBuilder.ViewedPartitionScheme

getset

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

Created in NX9.0.0

License requirements to get this property: nx_4gd_integration ("4th Generation Design")

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.ComponentAssembly NXOpen.Assemblies.SubsetBuilder.Workset

get

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

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

The documentation for this class was generated from the following file:

Assemblies_SubsetBuilder.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation