Represents a NXOpen::ReferenceSet
This is no KF creation
Created in NX6.0.0.
More...
Inheritance diagram for NXOpen::ReferenceSet:
Public Member Functions | |
| void | AddObjectsToReferenceSet (const std::vector< NXOpen::NXObject * > &components) |
| Addition of objects to reference set Created in NX6.0.0. More... | |
| std::vector< NXOpen::NXObject * > | AskAllDirectMembers () |
| Query of reference set members. More... | |
| std::vector< NXOpen::NXObject * > | AskMembersInReferenceSet () |
| Query of reference set members. More... | |
| bool | GetAddComponentsAutomatically () |
| Returns the add components automatically toggle value. More... | |
| void | RemoveObjectsFromReferenceSet (const std::vector< NXOpen::NXObject * > &components) |
| Removal of objects from reference set Created in NX6.0.0. More... | |
| void | SetAddComponentsAutomatically (bool newValue, bool addExistingComponents) |
| Sets the add components automatically toggle value. More... | |
 Public Member Functions inherited from NXOpen::DisplayableObject | |
| void | Blank () |
| Blanks the object. More... | |
| int | Color () |
| Returns the color of the object. More... | |
| void | Highlight () |
| Highlights the object. More... | |
| bool | IsBlanked () |
| Returns the blank status of this object. More... | |
| int | Layer () |
| Returns the layer that the object is in. More... | |
| NXOpen::DisplayableObject::ObjectFont | LineFont () |
| Returns the line font of the object. More... | |
| NXOpen::DisplayableObject::ObjectWidth | LineWidth () |
| Returns the line width of the object. More... | |
| NXOpen::Point3d | NameLocation () |
| Returns the location of the object's name. More... | |
| void | RedisplayObject () |
| Redisplays the object in all views. More... | |
| void | RemoveViewDependency () |
| Remove dependency on all views from an object. More... | |
| void | SetColor (int color) |
| Sets the color of the object. More... | |
| void | SetLayer (int layer) |
| Sets the layer that the object is in. More... | |
| void | SetLineFont (NXOpen::DisplayableObject::ObjectFont font) |
| Sets the line font of the object. More... | |
| void | SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width) |
| Sets the line width of the object. More... | |
| void | SetNameLocation (const NXOpen::Point3d &location) |
| Sets the location of the object's name. More... | |
| void | Unblank () |
| Unblanks the object. More... | |
| void | Unhighlight () |
| Unhighlights the object. More... | |
| Public Member Functions inherited from NXOpen::NXObject | |
| 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::NXObject::AttributeType type, NXOpen::Update::Option option) |
| Deletes the attributes encountered with the given Type with option to update or not. More... | |
| virtual NXOpen::INXObject * | FindObject (const NXString &journalIdentifier) |
| Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More... | |
| virtual NXOpen::INXObject * | FindObject (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... | |
| 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::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 () |
| 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< NXString > | GetUserAttributesAsStrings () |
| 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 (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::BasePart * | OwningPart () |
| 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::INXObject * | Prototype () |
| 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 | 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... | |
Additional Inherited Members | |
| Public Types inherited from NXOpen::DisplayableObject | |
| enum | ObjectFont { ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline, ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed } |
| specifies the object font for objects such as lines Created in NX3.0.0. More... | |
| enum | ObjectWidth { ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5, ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive, ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine } |
| specifies object width for objects such as lines and text Created in NX3.0.0. More... | |
Detailed Description
Represents a NXOpen::ReferenceSet
This is no KF creation
Created in NX6.0.0.
Member Function Documentation
| void NXOpen::ReferenceSet::AddObjectsToReferenceSet | ( | const std::vector< NXOpen::NXObject * > & | components | ) |
Addition of objects to reference set
Created in NX6.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
- Parameters
-
components Array of the selected objects to be added in the refernce set
| std::vector<NXOpen::NXObject *> NXOpen::ReferenceSet::AskAllDirectMembers | ( | ) |
Query of reference set members.
Includes solid bodies, facet bodies, miscellaneous entities other than solid and facet bodies and assembly components.
- Returns
- Members of reference set
Created in NX7.5.0.
License requirements : None
| std::vector<NXOpen::NXObject *> NXOpen::ReferenceSet::AskMembersInReferenceSet | ( | ) |
Query of reference set members.
Includes solid bodies, facet bodies and miscellaneous entities other than solid and facet bodies. Also includes entity objects like faces and edges. Does not include assembly components. This method may return some members which are not visible given the current feature state, but which would become visible if a different feature was made current. Use NXOpen::ReferenceSet::AskAllDirectMembers instead to avoid such members if desired.
- Returns
- Members of reference set
Created in NX6.0.0.
License requirements : None
| bool NXOpen::ReferenceSet::GetAddComponentsAutomatically | ( | ) |
Returns the add components automatically toggle value.
This controls whether new components added to the part will automatically get added to this reference set.
- Returns
- The current setting for the add components automatically property
Created in NX6.0.0.
License requirements : None
| void NXOpen::ReferenceSet::RemoveObjectsFromReferenceSet | ( | const std::vector< NXOpen::NXObject * > & | components | ) |
Removal of objects from reference set
Created in NX6.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
- Parameters
-
components Array of the selected objects to be removed from the refernce set
| void NXOpen::ReferenceSet::SetAddComponentsAutomatically | ( | bool | newValue, |
| bool | addExistingComponents | ||
| ) |
Sets the add components automatically toggle value.
This controls whether new components added to the part will automatically get added to this reference set.
Created in NX6.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
- Parameters
-
newValue The new setting for the add components automatically property addExistingComponents Specifies whether existing components should be added to the reference set, and only applies when newValue is true
The documentation for this class was generated from the following file:
- ReferenceSet.hxx