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

Inheritance diagram for NXOpen::Assemblies::SubsetBuilder:

Public Member Functions
bool	AddAllSubordinates ()
	Returns the value which determines whether the subset will include all the subordinates of reuse design elements.

NXOpen::CollaborativeDesign *	CollaborativeDesign ()
	Returns the CollaborativeDesign of the subset.

NXOpen::PDM::ConfigurationContextBuilder *	ConfigurationContext ()
	Returns the configuration context builder.

NXOpen::Assemblies::FindInCollaborativeDesign *	Finder ()
	Returns the Assemblies::FindInCollaborativeDesign for use in the context determined by this builder.

NXOpen::NXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

NXOpen::NXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

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

NXOpen::Assemblies::SubsetRecipe *	Recipe ()
	Returns the Assemblies::SubsetRecipe that contains the Assemblies::SearchTerm s used to generate the contents of the subset Created in NX8.5.0.

NXOpen::Assemblies::SearchResultCollection *	SearchResults ()
	Returns the Assemblies::SearchResultCollection that contains current search results associated with this subset builder.

void	SetAddAllSubordinates (bool addAllSubordinates)
	Sets the value which determines whether the subset will include all the subordinates of reuse design elements.

void	SetCollaborativeDesign (NXOpen::CollaborativeDesign *collaborativeDesign)
	Sets the CollaborativeDesign of the subset.

void	SetSubsetDescription (const NXString &description)
	Sets the description of the Assemblies::Subset .

void	SetSubsetDescription (const char *description)
	Sets the description of the Assemblies::Subset .

void	SetSubsetName (const NXString &name)
	Sets the name of the Assemblies::Subset .

void	SetSubsetName (const char *name)
	Sets the name of the Assemblies::Subset .

void	SetViewedPartitionScheme (NXOpen::Assemblies::PartitionScheme *partitionScheme)
	Sets the viewed PartitionScheme of the subset.

NXOpen::Assemblies::Subset *	Subset ()
	Returns the Assemblies::Subset that we are building.

NXOpen::Assemblies::SubsetConfigurationBuilder *	SubsetConfiguration ()
	Returns the subset configuration.

NXString	SubsetDescription ()
	Returns the description of the Assemblies::Subset .

NXString	SubsetName ()
	Returns the name of the Assemblies::Subset .

NXOpen::BasicEffectivityBuilder *	TargetEffectivity ()
	Returns the BasicEffectivityBuilder used to edit the target effectivity of the subset.

NXOpen::PDM::EffectivityTableBuilder *	TargetEffectivityTable ()
	Returns the PDM::EffectivityTableBuilder used to edit the target effectivity of the subset.

NXOpen::Assemblies::PartitionList *	TargetPartitionList ()
	Returns the default target Partition s for design elements created within the subset.

NXOpen::Assemblies::PartitionScheme *	ViewedPartitionScheme ()
	Returns the viewed PartitionScheme of the subset.

NXOpen::Assemblies::ComponentAssembly *	Workset ()
	Returns the Assemblies::ComponentAssembly within which we are building an Assemblies::Subset .

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

<br> To create a new instance of this class, use @link Assemblies::SubsetCollection::CreateSubsetBuilder  Assemblies::SubsetCollection::CreateSubsetBuilder @endlink  <br>

Created in NX8.5.0.

Member Function Documentation

bool NXOpen::Assemblies::SubsetBuilder::AddAllSubordinates ( )

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

Created in NX9.0.0.

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

NXOpen::CollaborativeDesign* NXOpen::Assemblies::SubsetBuilder::CollaborativeDesign ( )

Returns the CollaborativeDesign of the subset.

Created in NX8.5.0.

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

NXOpen::PDM::ConfigurationContextBuilder* NXOpen::Assemblies::SubsetBuilder::ConfigurationContext ( )

Returns the configuration context builder.

Created in NX9.0.0.

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

NXOpen::Assemblies::FindInCollaborativeDesign* NXOpen::Assemblies::SubsetBuilder::Finder ( )

Returns the 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::NXObject* NXOpen::Assemblies::SubsetBuilder::FindObject ( const NXString & journalIdentifier )

Finds the 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.  @return  Object found, or null if no such object exists

Created in NX8.5.0.

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

Parameters

journalIdentifier Identifier of the NXObject to be found

NXOpen::NXObject* NXOpen::Assemblies::SubsetBuilder::FindObject ( const char * journalIdentifier )

Finds the 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.  @return  Object found, or null if no such object exists

Created in NX8.5.0.

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

Parameters

journalIdentifier Identifier of the NXObject to be found

void NXOpen::Assemblies::SubsetBuilder::GenerateResults ( )

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

Created in NX8.5.0.

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

NXOpen::Assemblies::SubsetRecipe* NXOpen::Assemblies::SubsetBuilder::Recipe ( )

Returns the Assemblies::SubsetRecipe that contains the Assemblies::SearchTerm s used to generate the contents of the subset
Created in NX8.5.0.

NXOpen::Assemblies::SearchResultCollection* NXOpen::Assemblies::SubsetBuilder::SearchResults ( )

Returns the 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 @link SubsetBuilder::GenerateResults SubsetBuilder::GenerateResults@endlink 
       after that method is first called. 
       In addition, the last results from @link SubsetBuilder::Finder SubsetBuilder::Finder@endlink  are included in this
       collection.

Created in NX8.5.0.

void NXOpen::Assemblies::SubsetBuilder::SetAddAllSubordinates ( bool addAllSubordinates )

Sets the value which determines whether the subset will include all the subordinates of reuse design elements.

Created in NX9.0.0.

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

Parameters

addAllSubordinates addallsubordinates

void NXOpen::Assemblies::SubsetBuilder::SetCollaborativeDesign ( NXOpen::CollaborativeDesign * collaborativeDesign )

Sets the CollaborativeDesign of the subset.

Created in NX8.5.0.

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

Parameters

collaborativeDesign collaborativedesign

void NXOpen::Assemblies::SubsetBuilder::SetSubsetDescription ( const NXString & description )

Sets the description of the Assemblies::Subset .

Created in NX8.5.0.

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

Parameters

description description

void NXOpen::Assemblies::SubsetBuilder::SetSubsetDescription ( const char * description )

Sets the description of the Assemblies::Subset .

Created in NX8.5.0.

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

Parameters

description description

void NXOpen::Assemblies::SubsetBuilder::SetSubsetName ( const NXString & name )

Sets the name of the Assemblies::Subset .

Created in NX8.5.0.

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

Parameters

name name

void NXOpen::Assemblies::SubsetBuilder::SetSubsetName ( const char * name )

Sets the name of the Assemblies::Subset .

Created in NX8.5.0.

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

Parameters

name name

void NXOpen::Assemblies::SubsetBuilder::SetViewedPartitionScheme ( NXOpen::Assemblies::PartitionScheme * partitionScheme )

Sets the viewed PartitionScheme of the subset.

Created in NX9.0.0.

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

Parameters

partitionScheme partitionscheme

NXOpen::Assemblies::Subset* NXOpen::Assemblies::SubsetBuilder::Subset ( )

Returns the Assemblies::Subset that we are building.

Created in NX8.5.0.

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

NXOpen::Assemblies::SubsetConfigurationBuilder* NXOpen::Assemblies::SubsetBuilder::SubsetConfiguration ( )

Returns the subset configuration.

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

Created in NX8.5.0.

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

NXString NXOpen::Assemblies::SubsetBuilder::SubsetDescription ( )

Returns the description of the Assemblies::Subset .

Created in NX8.5.0.

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

NXString NXOpen::Assemblies::SubsetBuilder::SubsetName ( )

Returns the name of the Assemblies::Subset .

Created in NX8.5.0.

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

NXOpen::BasicEffectivityBuilder* NXOpen::Assemblies::SubsetBuilder::TargetEffectivity ( )

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

Deprecated:: Deprecated in NX9.0.0. Use SubsetBuilder::TargetEffectivityTable instead.

Created in NX8.5.0.

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

NXOpen::PDM::EffectivityTableBuilder* NXOpen::Assemblies::SubsetBuilder::TargetEffectivityTable ( )

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

Created in NX9.0.0.

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

NXOpen::Assemblies::PartitionList* NXOpen::Assemblies::SubsetBuilder::TargetPartitionList ( )

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

Created in NX8.5.0.

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

NXOpen::Assemblies::PartitionScheme* NXOpen::Assemblies::SubsetBuilder::ViewedPartitionScheme ( )

Returns the viewed PartitionScheme of the subset.

Created in NX9.0.0.

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

NXOpen::Assemblies::ComponentAssembly* NXOpen::Assemblies::SubsetBuilder::Workset ( )

Returns the Assemblies::ComponentAssembly within which we are building an 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.hxx

Public Member Functions

Detailed Description

Member Function Documentation