NX Open C++ Reference Guide
|
A subset is a set of design elements within a collaborative design. More...
Public Types | |
enum | PartitionViewStyleType { PartitionViewStyleTypeNone, PartitionViewStyleTypeFlat, PartitionViewStyleTypeHierarchical } |
Represents the type of partition view style to show for a subset. More... | |
![]() | |
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. | |
void | AddConnectedByElements () |
Add Elements to a subset that reference the existing Design Elements in it by a Connection relation. | |
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. | |
NXOpen::Assemblies::Component * | ComponentInWorkset () |
Returns the Component that corresponds to this subset in the workset ComponentAssembly . | |
void | DeleteFromCollaborativeDesign (const std::vector< NXOpen::NXObject * > &designElement) |
Deletes the design elements from the owning CollaborativeDesign . | |
NXString | Description () |
Returns the description of this subset. | |
std::vector < NXOpen::PDM::DesignElementRevision * > | GetDesignElementRevisionMembers () |
The PDM::DesignElementRevision s that are members of this subset. | |
std::vector < NXOpen::PDM::DesignElementRevision * > | GetDesignElementRevisionParents () |
The PDM::DesignElementRevision s that have been loaded because they contain a PDM::DesignSubordinateRevision that belongs to this subset. | |
std::vector < NXOpen::PDM::DesignSubordinateRevision * > | GetDesignSubordinateRevisionMembers () |
The PDM::DesignSubordinateRevision s that are members of this subset. | |
std::vector < NXOpen::PDM::DesignSubordinateRevision * > | GetDesignSubordinateRevisionParents () |
The PDM::DesignSubordinateRevision s that have been loaded because they contain a PDM::DesignSubordinateRevision that belongs to this subset. | |
void | HideCollaborativeDesignPreview () |
Hides the preview for the Collaborative Design in the graphics window if it was already displayed. | |
bool | IsCollaborativeDesignPreviewDisplayed () |
Is the preview for the Collaborative Design being displayed in the Graphics window. | |
NXOpen::Assemblies::Subset::PartitionViewStyleType | PartitionViewStyle () |
Returns the partition view style to show. | |
void | RemoveDesignElements (const std::vector< NXOpen::NXObject * > &designElements) |
Removes the design elements from this subset. | |
void | ReplayRecipe () |
Replay this subset. | |
void | SetPartitionViewStyle (NXOpen::Assemblies::Subset::PartitionViewStyleType partitionViewStyle) |
Sets the partition view style to show. | |
void | SetShowSubsetStructure (bool showSubsetStructure) |
Sets the subset structure to be shown or not. | |
bool | ShowCollaborativeDesignPreview () |
Displays the preview for the Collaborative Design in the graphics window. | |
bool | ShowSubsetStructure () |
Returns the subset structure to be shown or not. | |
![]() | |
void | DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type) |
Deletes all attributes of a specific type. | |
void | DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option) |
Deletes all attributes of a specific type with the option to update or not. | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title) |
Deletes an attribute by type and title. | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title) |
Deletes an attribute by type and title. | |
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. | |
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. | |
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 and Index. | |
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 and Index. | |
void | DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option) |
Deletes the attributes encountered with the given Type with option to update or not. | |
virtual NXOpen::INXObject * | FindObject (const NXString &journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. | |
NXOpen::INXObject * | FindObject (const char *journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type) |
Gets all the attribute titles of a specific type. | |
bool | GetBooleanUserAttribute (const NXString &title, int index) |
Gets a boolean attribute by Title and array Index. | |
bool | GetBooleanUserAttribute (const char *title, int index) |
Gets a boolean attribute by Title and array Index. | |
NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const NXString &title, int index) |
Gets a time attribute by Title and array Index. | |
NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const char *title, int index) |
Gets a time attribute by Title and array Index. | |
int | GetIntegerAttribute (const NXString &title) |
Gets an integer attribute by title. | |
int | GetIntegerAttribute (const char *title) |
Gets an integer attribute by title. | |
int | GetIntegerUserAttribute (const NXString &title, int index) |
Gets an integer attribute by Title and array Index. | |
int | GetIntegerUserAttribute (const char *title, int index) |
Gets an integer attribute by Title and array Index. | |
double | GetRealAttribute (const NXString &title) |
Gets a real attribute by title. | |
double | GetRealAttribute (const char *title) |
Gets a real attribute by title. | |
double | GetRealUserAttribute (const NXString &title, int index) |
Gets a real attribute by Title and array Index. | |
double | GetRealUserAttribute (const char *title, int index) |
Gets a real attribute by Title and array Index. | |
NXString | GetReferenceAttribute (const NXString &title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. | |
NXString | GetReferenceAttribute (const char *title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. | |
NXString | GetStringAttribute (const NXString &title) |
Gets a string attribute value by title. | |
NXString | GetStringAttribute (const char *title) |
Gets a string attribute value by title. | |
NXString | GetStringUserAttribute (const NXString &title, int index) |
Gets a string attribute by Title and array Index. | |
NXString | GetStringUserAttribute (const char *title, int index) |
Gets a string attribute by Title and array Index. | |
NXString | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title) |
Gets a time attribute by title. | |
NXString | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title) |
Gets a time attribute by title. | |
NXString | GetTimeUserAttribute (const NXString &title, int index) |
Gets a time attribute by Title and array Index. | |
NXString | GetTimeUserAttribute (const char *title, int index) |
Gets a time attribute by Title and array Index. | |
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. | |
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. | |
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. | |
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. | |
bool | GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type) |
Determine the lock of the given attribute. | |
bool | GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type) |
Determine the lock of the given attribute. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes () |
Gets all the attributes that have been set on the given object. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset) |
Gets all the attributes that have been set on the given object. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset, bool addStringValues) |
Gets all the attributes that have been set on the given object. | |
std::vector< NXString > | GetUserAttributesAsStrings () |
Gets all the attributes that have been set on the given object. | |
std::vector< NXOpen::NXObject * > | GetUserAttributeSourceObjects () |
Returns an array of objects from which this object presents attributes. | |
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 If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). | |
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 If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). | |
virtual bool | IsOccurrence () |
Returns whether this object is an occurrence or not. | |
virtual NXString | JournalIdentifier () |
Returns the identifier that would be recorded in a journal for this object. | |
virtual NXString | Name () |
Returns the custom name of the object. | |
virtual NXOpen::Assemblies::Component * | OwningComponent () |
Returns the owning component, if this object is an occurrence. | |
virtual NXOpen::BasePart * | OwningPart () |
Returns the owning part of this object Created in NX3.0.0. | |
virtual void | Print () |
Prints a representation of this object to the system log file. | |
virtual NXOpen::INXObject * | Prototype () |
Returns the prototype of this object if it is an occurrence. | |
void | SetAttribute (const NXString &title, int value) |
Creates or modifies an integer attribute. | |
void | SetAttribute (const char *title, int value) |
Creates or modifies an integer attribute. | |
void | SetAttribute (const NXString &title, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. | |
void | SetAttribute (const char *title, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. | |
void | SetAttribute (const NXString &title, double value) |
Creates or modifies a real attribute. | |
void | SetAttribute (const char *title, double value) |
Creates or modifies a real attribute. | |
void | SetAttribute (const NXString &title, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. | |
void | SetAttribute (const char *title, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. | |
void | SetAttribute (const NXString &title, const NXString &value) |
Creates or modifies a string attribute. | |
void | SetAttribute (const char *title, const char *value) |
Creates or modifies a string attribute. | |
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. | |
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. | |
void | SetAttribute (const NXString &title) |
Creates or modifies a null attribute which is an attribute with a title and no value. | |
void | SetAttribute (const char *title) |
Creates or modifies a null attribute which is an attribute with a title and no value. | |
void | SetAttribute (const NXString &title, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
void | SetAttribute (const char *title, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
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. | |
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. | |
virtual void | SetName (const NXString &name) |
Sets the custom name of the object. | |
void | SetName (const char *name) |
Sets the custom name of the object. | |
void | SetReferenceAttribute (const NXString &title, const NXString &value) |
Creates or modifies a string attribute which uses a reference string. | |
void | SetReferenceAttribute (const char *title, const char *value) |
Creates or modifies a string attribute which uses a reference string. | |
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. | |
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. | |
void | SetTimeAttribute (const NXString &title, const NXString &value) |
Creates or modifies a time attribute. | |
void | SetTimeAttribute (const char *title, const char *value) |
Creates or modifies a time attribute. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
void | SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option) |
Creates or modifies an attribute with the option to update or not. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
void | SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
void | SetUserAttribute (const char *title, int index, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
void | SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock) |
Lock or unlock the given attribute. | |
void | SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock) |
Lock or unlock the given attribute. | |
![]() | |
tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
tag_t | Tag () const |
Returns the tag of this object. | |
![]() | |
NXOpen::INXObject * | FindObject (const char *journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. | |
void | SetName (const char *name) |
Sets the custom name of the object. | |
A subset is a set of design elements within a collaborative design.
<br> To create or edit an instance of this class, use @link Assemblies::SubsetBuilder Assemblies::SubsetBuilder @endlink <br>
Created in NX8.5.0.
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")
reuseDesignElements | reusedesignelements |
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 @link JA_SUBSET_AddInterpartParents JA_SUBSET_AddInterpartParents@endlink "
Created in NX8.5.1.
License requirements : nx_4gd_integration ("4th Generation Design")
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")
NXOpen::Assemblies::Component* NXOpen::Assemblies::Subset::ComponentInWorkset | ( | ) |
Returns the Component that corresponds to this subset in the workset 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 CollaborativeDesign .
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
designElement | designelement |
NXString NXOpen::Assemblies::Subset::Description | ( | ) |
Returns the description of this subset.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
std::vector<NXOpen::PDM::DesignElementRevision *> NXOpen::Assemblies::Subset::GetDesignElementRevisionMembers | ( | ) |
The 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 @link PDM::DesignSubordinateRevision PDM::DesignSubordinateRevision@endlink that belongs to this subset. See @link GetDesignElementRevisionParents GetDesignElementRevisionParents@endlink @return
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
std::vector<NXOpen::PDM::DesignElementRevision *> NXOpen::Assemblies::Subset::GetDesignElementRevisionParents | ( | ) |
The PDM::DesignElementRevision s that have been loaded because they contain a PDM::DesignSubordinateRevision that belongs to this subset.
@return
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
std::vector<NXOpen::PDM::DesignSubordinateRevision *> NXOpen::Assemblies::Subset::GetDesignSubordinateRevisionMembers | ( | ) |
The 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 @link PDM::DesignSubordinateRevision PDM::DesignSubordinateRevision@endlink that belongs to this subset. See @link GetDesignSubordinateRevisionParents GetDesignSubordinateRevisionParents@endlink @return
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
std::vector<NXOpen::PDM::DesignSubordinateRevision *> NXOpen::Assemblies::Subset::GetDesignSubordinateRevisionParents | ( | ) |
The PDM::DesignSubordinateRevision s that have been loaded because they contain a PDM::DesignSubordinateRevision that belongs to this subset.
@return
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
void NXOpen::Assemblies::Subset::HideCollaborativeDesignPreview | ( | ) |
Hides the preview for the Collaborative Design in the graphics window if it was already displayed.
See @link ShowCollaborativeDesignPreview ShowCollaborativeDesignPreview@endlink .
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.
@return
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 CollaborativeDesign .
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
designElements | designelements |
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::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")
partitionViewStyle | partitionviewstyle |
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")
showSubsetStructure | showsubsetstructure |
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 @link HideCollaborativeDesignPreview HideCollaborativeDesignPreview@endlink . @return
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")