NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Assemblies::Subset Class Reference

A subset is a set of design elements within a collaborative design. More...

Inheritance diagram for NXOpen::Assemblies::Subset:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

Public Types

enum  ContentType { ContentTypePublic, ContentTypeBaseline, ContentTypeChangeNotice }
 Represents the content type for a subset. More...
 
enum  PartitionViewStyleType { PartitionViewStyleTypeNone, PartitionViewStyleTypeFlat, PartitionViewStyleTypeHierarchical }
 Represents the type of partition view style to show for a subset. More...
 
- Public Types inherited from NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger,
  AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference,
  AttributeTypeAny = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
 Specifies the format of the date and time attribute. More...
 

Public Member Functions

void AddAllChildrenToSubset (const std::vector< NXOpen::Assemblies::Component * > &reuseDesignElements)
 Adds all the child components of the selected Reuse Design Element to the owning subset. More...
 
void AddConnectedByElements ()
 Add Elements to a subset that reference the existing Design Elements in it by a Connection relation. More...
 
NXOpen::PartLoadStatusAddDesignElementsToSubset (const std::vector< NXOpen::PDM::ModelElementRevision * > &designElements)
 Adds the specified NXOpen::PDM::ModelElementRevision s as members of the subset. More...
 
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. More...
 
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. More...
 
bool AllowMultipleTargetPartitions ()
 Returns the allow multiple target partitions property, if set to false (default) only first target partition will be considered. More...
 
bool CanReplaceContentDefinition (NXOpen::ContentDefinition *contentDefinition)
 Checks if the NXOpen::ContentDefinition object on the Subset can be replaced with the specified NXOpen::ContentDefinition object. More...
 
NXOpen::Assemblies::ComponentComponentInWorkset ()
 Returns the NXOpen::Assemblies::Component that corresponds to this subset in the workset NXOpen::Assemblies::ComponentAssembly . More...
 
void DeleteFromCollaborativeDesign (const std::vector< NXOpen::NXObject * > &designElement)
 Deletes the design elements from the owning NXOpen::CollaborativeDesign . More...
 
void DeletePositioningTask (NXOpen::Assemblies::PositioningTask *positioningTask)
 Deletes the NXOpen::Assemblies::PositioningTask from this subset. More...
 
NXString Description ()
 Returns the description of this subset. More...
 
bool DisplayExcludedDesignElements ()
 Returns the design elements excluded from spatial search to be displayed or not. More...
 
std::vector
< NXOpen::Assemblies::PositioningTask * > 
GetAllPositioningTasks ()
 Gets all NXOpen::Assemblies::PositioningTask that belong to this subset. More...
 
std::vector
< NXOpen::PDM::DesignElementRevision * > 
GetDesignElementRevisionMembers ()
 The NXOpen::PDM::DesignElementRevision s that are members of this subset. More...
 
std::vector
< NXOpen::PDM::DesignElementRevision * > 
GetDesignElementRevisionParents ()
 The NXOpen::PDM::DesignElementRevision s that have been loaded because they contain a NXOpen::PDM::DesignSubordinateRevision that belongs to this subset. More...
 
std::vector
< NXOpen::PDM::DesignSubordinateRevision * > 
GetDesignSubordinateRevisionMembers ()
 The NXOpen::PDM::DesignSubordinateRevision s that are members of this subset. More...
 
std::vector
< NXOpen::PDM::DesignSubordinateRevision * > 
GetDesignSubordinateRevisionParents ()
 The NXOpen::PDM::DesignSubordinateRevision s that have been loaded because they contain a NXOpen::PDM::DesignSubordinateRevision that belongs to this subset. More...
 
void GetTargetPartitionSet (std::vector< NXOpen::Assemblies::Partition * > &partitions)
 Gets the list of array of target partitions that are set on the subsetInstance. More...
 
void HideCollaborativeDesignPreview ()
 Hides the preview for the Collaborative Design in the graphics window if it was already displayed. More...
 
bool IsCollaborativeDesignPreviewDisplayed ()
 Is the preview for the Collaborative Design being displayed in the Graphics window. More...
 
NXOpen::Assemblies::Subset::PartitionViewStyleType PartitionViewStyle ()
 Returns the partition view style to show. More...
 
void RemoveDesignElements (const std::vector< NXOpen::NXObject * > &designElements)
 Removes the design elements from this subset. More...
 
void ReplaceContentDefinition (NXOpen::ContentDefinition *contentDefinition)
 Replace the NXOpen::ContentDefinition object on the Subset. More...
 
void ReplayRecipe ()
 Replay this subset. More...
 
void SetAllowMultipleTargetPartitions (bool allowMultiplePartitions)
 Sets the allow multiple target partitions property, if set to false (default) only first target partition will be considered. More...
 
void SetContentDefinition (NXOpen::ContentDefinition *contentDefinition)
 Set a new NXOpen::ContentDefinition object on the Subset. More...
 
void SetDisplayExcludedDesignElements (bool displayExcluded)
 Sets the design elements excluded from spatial search to be displayed or not. More...
 
void SetPartitionViewStyle (NXOpen::Assemblies::Subset::PartitionViewStyleType partitionViewStyle)
 Sets the partition view style to show. More...
 
void SetShowSubsetStructure (bool showSubsetStructure)
 Sets the subset structure to be shown or not. More...
 
void SetTargetPartitionSet (const std::vector< NXOpen::Assemblies::Partition * > &partitions)
 Sets the list of array of target partitions on the subsetInstance. More...
 
bool ShowCollaborativeDesignPreview ()
 Displays the preview for the Collaborative Design in the graphics window. More...
 
bool ShowSubsetStructure ()
 Returns the subset structure to be shown or not. More...
 
NXOpen::Assemblies::Subset::ContentType SubsetType ()
 Returns the type of plm object used to create subset. More...
 
- Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIteratorCreateAttributeIterator ()
 Create an attribute iterator. More...
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
 Deletes all attributes of a specific type. More...
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator
Created in NX8.0.0. More...
 
void DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
bool GetBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
bool GetBooleanUserAttribute (const char *title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
int GetIntegerAttribute (const NXString &title)
 Gets an integer attribute by title. More...
 
int GetIntegerAttribute (const char *title)
 Gets an integer attribute by title. More...
 
int GetIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index. More...
 
int GetIntegerUserAttribute (const char *title, int index)
 Gets an integer attribute by Title and array Index. More...
 
bool GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
NXString GetPdmReferenceAttributeValue (const NXString &attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
NXString GetPdmReferenceAttributeValue (const char *attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
double GetRealAttribute (const NXString &title)
 Gets a real attribute by title. More...
 
double GetRealAttribute (const char *title)
 Gets a real attribute by title. More...
 
double GetRealUserAttribute (const NXString &title, int index)
 Gets a real attribute by Title and array Index. More...
 
double GetRealUserAttribute (const char *title, int index)
 Gets a real attribute by Title and array Index. More...
 
NXString GetReferenceAttribute (const NXString &title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetReferenceAttribute (const char *title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetStringAttribute (const NXString &title)
 Gets a string attribute value by title. More...
 
NXString GetStringAttribute (const char *title)
 Gets a string attribute value by title. More...
 
NXString GetStringUserAttribute (const NXString &title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetStringUserAttribute (const char *title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
 Gets a time attribute by title. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
 Gets a time attribute by title. More...
 
NXString GetTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXString GetTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
NXString GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
NXString GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
bool GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (NXOpen::AttributeIterator *iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
std::vector< NXStringGetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
int GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
int GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
bool HasUserAttribute (NXOpen::AttributeIterator *iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator. More...
 
bool HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
bool HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
virtual bool IsOccurrence ()
 Returns whether this object is an occurrence or not. More...
 
virtual NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual NXString Name ()
 Returns the custom name of the object. More...
 
virtual
NXOpen::Assemblies::Component
OwningComponent ()
 Returns the owning component, if this object is an occurrence. More...
 
virtual NXOpen::BasePartOwningPart ()
 Returns the owning part of this object
Created in NX3.0.0. More...
 
virtual void Print ()
 Prints a representation of this object to the system log file. More...
 
virtual NXOpen::INXObjectPrototype ()
 Returns the prototype of this object if it is an occurrence. More...
 
void SetAttribute (const NXString &title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const char *title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const char *title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const char *title, const char *value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const char *title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const NXString &title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetAttribute (const char *title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
virtual void SetName (const NXString &name)
 Sets the custom name of the object. More...
 
virtual void SetName (const char *name)
 Sets the custom name of the object. More...
 
void SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const char *title, const char *value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const char *title, const char *value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

A subset is a set of design elements within a collaborative design.


To create or edit an instance of this class, use NXOpen::Assemblies::SubsetBuilder

Created in NX8.5.0.

Member Enumeration Documentation

Represents the content type for a subset.

Enumerator
ContentTypePublic 

Represents a public content subset.

ContentTypeBaseline 

Represents a baseline content subset.

ContentTypeChangeNotice 

Represents a change notice content subset.

Represents the type of partition view style to show for a subset.

Enumerator
PartitionViewStyleTypeNone 

Show no partition view style for subset.

PartitionViewStyleTypeFlat 

Show flat partition view style for subset.

PartitionViewStyleTypeHierarchical 

Show hierachical view style for subset.

Member Function Documentation

void NXOpen::Assemblies::Subset::AddAllChildrenToSubset ( const std::vector< NXOpen::Assemblies::Component * > &  reuseDesignElements)

Adds all the child components of the selected Reuse Design Element to the owning subset.


Created in NX8.5.0.

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

Parameters
reuseDesignElementsreusedesignelements
void NXOpen::Assemblies::Subset::AddConnectedByElements ( )

Add Elements to a subset that reference the existing Design Elements in it by a Connection relation.

A typical example will be to add Weld Design Features that reference any of the Design Elements in this subset. The recipe will be modified and explicit include terms will be added for each Element. The modified recipe will be replayed at the end of the operation. See NXOpen::Assemblies::Subset::AddInterpartParents "


Created in NX8.5.1.

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

NXOpen::PartLoadStatus* NXOpen::Assemblies::Subset::AddDesignElementsToSubset ( const std::vector< NXOpen::PDM::ModelElementRevision * > &  designElements)

Adds the specified NXOpen::PDM::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 NXOpen::Assemblies::Subset::ReplayRecipe

Returns

Created in NX11.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")
Parameters
designElementsdesignelements
void NXOpen::Assemblies::Subset::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.

The recipe will be modified and explicit include terms will be added for each parent. The modified recipe will be replayed at the end of the operation.


Created in NX8.5.0.

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

void NXOpen::Assemblies::Subset::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.


Created in NX8.5.0.

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

bool NXOpen::Assemblies::Subset::AllowMultipleTargetPartitions ( )

Returns the allow multiple target partitions property, if set to false (default) only first target partition will be considered.


Created in NX12.0.0.

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

bool NXOpen::Assemblies::Subset::CanReplaceContentDefinition ( NXOpen::ContentDefinition contentDefinition)

Checks if the NXOpen::ContentDefinition object on the Subset can be replaced with the specified NXOpen::ContentDefinition object.

Returns

Created in NX11.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")
Parameters
contentDefinitioncontentdefinition
NXOpen::Assemblies::Component* NXOpen::Assemblies::Subset::ComponentInWorkset ( )

Returns the NXOpen::Assemblies::Component that corresponds to this subset in the workset NXOpen::Assemblies::ComponentAssembly .


Created in NX8.5.0.

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

void NXOpen::Assemblies::Subset::DeleteFromCollaborativeDesign ( const std::vector< NXOpen::NXObject * > &  designElement)

Deletes the design elements from the owning NXOpen::CollaborativeDesign .


Created in NX8.5.0.

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

Parameters
designElementdesignelement
void NXOpen::Assemblies::Subset::DeletePositioningTask ( NXOpen::Assemblies::PositioningTask positioningTask)

Deletes the NXOpen::Assemblies::PositioningTask from this subset.


Created in NX10.0.0.

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

Parameters
positioningTaskpositioningtask
NXString NXOpen::Assemblies::Subset::Description ( )

Returns the description of this subset.


Created in NX8.5.0.

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

bool NXOpen::Assemblies::Subset::DisplayExcludedDesignElements ( )

Returns the design elements excluded from spatial search to be displayed or not.


Created in NX10.0.0.

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

std::vector<NXOpen::Assemblies::PositioningTask *> NXOpen::Assemblies::Subset::GetAllPositioningTasks ( )

Gets all NXOpen::Assemblies::PositioningTask that belong to this subset.

Returns

Created in NX10.0.0.

License requirements : None
std::vector<NXOpen::PDM::DesignElementRevision *> NXOpen::Assemblies::Subset::GetDesignElementRevisionMembers ( )

The NXOpen::PDM::DesignElementRevision s that are members of this subset.

Note that this does not include elements that have been loaded only because they contain a NXOpen::PDM::DesignSubordinateRevision that belongs to this subset. See GetDesignElementRevisionParents

Returns

Created in NX8.5.0.

License requirements : nx_4gd_integration ("4th Generation Design")
std::vector<NXOpen::PDM::DesignElementRevision *> NXOpen::Assemblies::Subset::GetDesignElementRevisionParents ( )

The NXOpen::PDM::DesignElementRevision s that have been loaded because they contain a NXOpen::PDM::DesignSubordinateRevision that belongs to this subset.

Returns

Created in NX8.5.0.

License requirements : nx_4gd_integration ("4th Generation Design")
std::vector<NXOpen::PDM::DesignSubordinateRevision *> NXOpen::Assemblies::Subset::GetDesignSubordinateRevisionMembers ( )

The NXOpen::PDM::DesignSubordinateRevision s that are members of this subset.

Note that this does not include elements that have been loaded only because they contain a NXOpen::PDM::DesignSubordinateRevision that belongs to this subset. See GetDesignSubordinateRevisionParents

Returns

Created in NX8.5.0.

License requirements : nx_4gd_integration ("4th Generation Design")
std::vector<NXOpen::PDM::DesignSubordinateRevision *> NXOpen::Assemblies::Subset::GetDesignSubordinateRevisionParents ( )

The NXOpen::PDM::DesignSubordinateRevision s that have been loaded because they contain a NXOpen::PDM::DesignSubordinateRevision that belongs to this subset.

Returns

Created in NX8.5.0.

License requirements : nx_4gd_integration ("4th Generation Design")
void NXOpen::Assemblies::Subset::GetTargetPartitionSet ( std::vector< NXOpen::Assemblies::Partition * > &  partitions)

Gets the list of array of target partitions that are set on the subsetInstance.


Created in NX12.0.0.

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

Parameters
partitionspartitions
void NXOpen::Assemblies::Subset::HideCollaborativeDesignPreview ( )

Hides the preview for the Collaborative Design in the graphics window if it was already displayed.

See ShowCollaborativeDesignPreview .


Created in NX8.5.1.

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

bool NXOpen::Assemblies::Subset::IsCollaborativeDesignPreviewDisplayed ( )

Is the preview for the Collaborative Design being displayed in the Graphics window.

Returns

Created in NX8.5.1.

License requirements : nx_4gd_integration ("4th Generation Design")
NXOpen::Assemblies::Subset::PartitionViewStyleType NXOpen::Assemblies::Subset::PartitionViewStyle ( )

Returns the partition view style to show.


Created in NX9.0.0.

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

void NXOpen::Assemblies::Subset::RemoveDesignElements ( const std::vector< NXOpen::NXObject * > &  designElements)

Removes the design elements from this subset.

This will not delete the design element from the owning NXOpen::CollaborativeDesign .


Created in NX8.5.0.

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

Parameters
designElementsdesignelements
void NXOpen::Assemblies::Subset::ReplaceContentDefinition ( NXOpen::ContentDefinition contentDefinition)

Replace the NXOpen::ContentDefinition object on the Subset.


Created in NX11.0.0.

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

Parameters
contentDefinitioncontentdefinition
void NXOpen::Assemblies::Subset::ReplayRecipe ( )

Replay this subset.

This will perform a search using the current subset recipe and configuration. The contents of the subset will be changed accordingly.


Created in NX8.5.0.

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

void NXOpen::Assemblies::Subset::SetAllowMultipleTargetPartitions ( bool  allowMultiplePartitions)

Sets the allow multiple target partitions property, if set to false (default) only first target partition will be considered.


Created in NX12.0.0.

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

Parameters
allowMultiplePartitionsallowmultiplepartitions
void NXOpen::Assemblies::Subset::SetContentDefinition ( NXOpen::ContentDefinition contentDefinition)

Set a new NXOpen::ContentDefinition object on the Subset.


Created in NX11.0.0.

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

Parameters
contentDefinitioncontentdefinition
void NXOpen::Assemblies::Subset::SetDisplayExcludedDesignElements ( bool  displayExcluded)

Sets the design elements excluded from spatial search to be displayed or not.


Created in NX10.0.0.

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

Parameters
displayExcludeddisplayexcluded
void NXOpen::Assemblies::Subset::SetPartitionViewStyle ( NXOpen::Assemblies::Subset::PartitionViewStyleType  partitionViewStyle)

Sets the partition view style to show.


Created in NX9.0.0.

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

Parameters
partitionViewStylepartitionviewstyle
void NXOpen::Assemblies::Subset::SetShowSubsetStructure ( bool  showSubsetStructure)

Sets the subset structure to be shown or not.


Created in NX9.0.0.

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

Parameters
showSubsetStructureshowsubsetstructure
void NXOpen::Assemblies::Subset::SetTargetPartitionSet ( const std::vector< NXOpen::Assemblies::Partition * > &  partitions)

Sets the list of array of target partitions on the subsetInstance.


Created in NX12.0.0.

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

Parameters
partitionspartitions
bool NXOpen::Assemblies::Subset::ShowCollaborativeDesignPreview ( )

Displays the preview for the Collaborative Design in the graphics window.

The preview is stored as a JT dataset on the Collaborative Design. Any transformation specific to this subset will also be applied to the preview. isPreviewAvailable will be false if no JT dataset could be found. See HideCollaborativeDesignPreview .

Returns

Created in NX8.5.1.

License requirements : nx_4gd_integration ("4th Generation Design")
bool NXOpen::Assemblies::Subset::ShowSubsetStructure ( )

Returns the subset structure to be shown or not.


Created in NX9.0.0.

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

NXOpen::Assemblies::Subset::ContentType NXOpen::Assemblies::Subset::SubsetType ( )

Returns the type of plm object used to create subset.


Created in NX11.0.0.

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


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.