Represents a Selection Recipe based on attributes. More...
Inheritance diagram for NXOpen::CAE::AttributeSelectionRecipe:
Public Member Functions | |
| void | ClearAllAttributes () |
| Clear all attributes Created in NX12.0.0. More... | |
| int | ColorAttribute () |
| Returns the color attribute. More... | |
| bool | GetHasUserAttributes (const NXString &attributeName) |
| Gets the presence of the user attribute with given name. More... | |
| bool | GetHasUserAttributes (const char *attributeName) |
| Gets the presence of the user attribute with given name. More... | |
| void | GetUserAttributeNames (std::vector< NXString > &userAttributeNames) |
| Gets the names of all set user attributes. 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... | |
| void | GetUserAttributes (const NXString &attributeName, NXOpen::NXObject::AttributeInformation *lowValueAttribute, NXOpen::NXObject::AttributeInformation *highValueAttribute) |
| Gets the low and high value of user attribute with given name. More... | |
| void | GetUserAttributes (const char *attributeName, NXOpen::NXObject::AttributeInformation *lowValueAttribute, NXOpen::NXObject::AttributeInformation *highValueAttribute) |
| Gets the low and high value of user attribute with given name. More... | |
| bool | HasColorAttribute () |
| Returns the presence of the color attribute. More... | |
| bool | HasNameAttribute () |
| Returns the presence of the name attribute. More... | |
| NXString | NameAttribute () |
| Returns the name attribute. More... | |
| void | RemoveColorAttribute () |
| Removes the color attribute. More... | |
| void | RemoveNameAttribute () |
| Removes the name attribute. More... | |
| void | RemoveUserAttributes (const NXString &attributeName) |
| Removes the user attribute with given name. More... | |
| void | RemoveUserAttributes (const char *attributeName) |
| Removes the user attribute with given name. More... | |
| void | SetColorAttribute (int color) |
| Sets or adds the color attribute. More... | |
| void | SetNameAttribute (const NXString &name) |
| Sets or adds the name attribute. More... | |
| void | SetNameAttribute (const char *name) |
| Sets or adds the name attribute. More... | |
| void | SetUserAttributes (const NXString &attributeName, const NXOpen::NXObject::AttributeInformation &lowValueAttribute, const NXOpen::NXObject::AttributeInformation &highValueAttribute) |
| Sets or adds the low and high value of user attribute with given name. More... | |
| void | SetUserAttributes (const char *attributeName, const NXOpen::NXObject::AttributeInformation &lowValueAttribute, const NXOpen::NXObject::AttributeInformation &highValueAttribute) |
| Sets or adds the low and high value of user attribute with given name. More... | |
| void | SetUserAttributes (bool setNameAttribute, const NXString &nameAttribute, bool setColorAttribute, int colorAttribute, std::vector< NXString > &userAttributeNames, const std::vector< NXOpen::NXObject::AttributeInformation > &lowValueAttributes, const std::vector< NXOpen::NXObject::AttributeInformation > &highValueAttributes) |
| Convenience method to set multiple attributes at once. More... | |
| void | SetUserAttributes (bool setNameAttribute, const char *nameAttribute, bool setColorAttribute, int colorAttribute, std::vector< NXString > &userAttributeNames, const std::vector< NXOpen::NXObject::AttributeInformation > &lowValueAttributes, const std::vector< NXOpen::NXObject::AttributeInformation > &highValueAttributes) |
| Convenience method to set multiple attributes at once. More... | |
 Public Member Functions inherited from NXOpen::CAE::SelectionRecipe | |
| NXOpen::CAE::SelectionRecipeDisplay * | Display () |
| Returns the display attributes belonging to the Selection Recipe Created in NX12.0.0. More... | |
| std::vector < NXOpen::TaggedObject * > | GetEntities () |
| Gets entities in the Selection Recipe. More... | |
| void | GetEntityTypes (std::vector< NXOpen::CAE::CaeSetGroupFilterType > &entityTypes) |
| Returns Entity Types supported by the Selection Recipe. More... | |
| NXString | GetName () |
| Gets the name of the Selection Recipe. More... | |
| bool | HasNonDisplayableEntities () |
| Returns whether the Selection Recipe has non-displayable entities. More... | |
| void | HideContents () |
| Hide the contents of the Selection Recipe. More... | |
| void | Information () |
| Display information of this Selection Recipe Created in NX12.0.0. More... | |
| void | SetName (const NXString &name) |
| Sets the name of the Selection Recipe Created in NX12.0.0. More... | |
| void | SetName (const char *name) |
| Sets the name of the Selection Recipe Created in NX12.0.0. More... | |
| void | ShowContents () |
| Show the contents of the Selection Recipe. More... | |
| void | ShowContentsOnly () |
| Shows the contents of the Selection Recipe only. 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 | |
| NXOpen::AttributeIterator * | CreateAttributeIterator () |
| 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::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... | |
| 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< 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 (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::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... | |
| 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... | |
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 Selection Recipe based on attributes.
To obtain an instance of this object use one of the creators in NXOpen::CAE::SelectionRecipeCollection .
Created in NX12.0.0.
Member Function Documentation
| void NXOpen::CAE::AttributeSelectionRecipe::ClearAllAttributes | ( | ) |
Clear all attributes
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
| int NXOpen::CAE::AttributeSelectionRecipe::ColorAttribute | ( | ) |
Returns the color attribute.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
| bool NXOpen::CAE::AttributeSelectionRecipe::GetHasUserAttributes | ( | const NXString & | attributeName | ) |
Gets the presence of the user attribute with given name.
- Returns
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
attributeName attributename
| bool NXOpen::CAE::AttributeSelectionRecipe::GetHasUserAttributes | ( | const char * | attributeName | ) |
Gets the presence of the user attribute with given name.
- Returns
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
attributeName attributename
| void NXOpen::CAE::AttributeSelectionRecipe::GetUserAttributeNames | ( | std::vector< NXString > & | userAttributeNames | ) |
Gets the names of all set user attributes.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
userAttributeNames userattributenames
| std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::CAE::AttributeSelectionRecipe::GetUserAttributes | ( | NXOpen::AttributeIterator * | iterator | ) |
Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
The results will not include information from associated attribute templates of unset attributes. The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returned as being of type NXOpen::NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.
- Returns
Created in NX11.0.0.
License requirements : None
- Parameters
-
iterator NXOpen::AttributeIterator
| std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::CAE::AttributeSelectionRecipe::GetUserAttributes | ( | ) |
Gets all the attributes that have been set on the given object.
The results will not include information from associated attribute templates of unset attributes. The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returned as being of type NXOpen::NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.
- Returns
Created in NX8.0.0.
License requirements : None
| std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::CAE::AttributeSelectionRecipe::GetUserAttributes | ( | bool | includeUnset | ) |
Gets all the attributes of the given object.
Includes option to return information also from associated attribute templates of unset attributes. The values returned for unset attributes are the default values from the templates. The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returnes as being of type NXOpen::NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.
- Returns
Created in NX8.0.0.
License requirements : None
- Parameters
-
includeUnset includeunset
| std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::CAE::AttributeSelectionRecipe::GetUserAttributes | ( | bool | includeUnset, |
| bool | addStringValues | ||
| ) |
Gets all the attributes of the given object.
Includes option to return information also from associated attribute templates of unset attributes. The values returned for unset attributes are the default values from the templates. Includes an option to return the value not only in the natural type, but also converted to a string (effective only for non-string attributes). The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returned as being of type NXOpen::NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.
- Returns
- Deprecated:
- Deprecated in NX11.0.0. Use GetUserAttributes instead.
Created in NX8.5.0.
License requirements : None
- Parameters
-
includeUnset includeunset addStringValues addstringvalues
| void NXOpen::CAE::AttributeSelectionRecipe::GetUserAttributes | ( | const NXString & | attributeName, |
| NXOpen::NXObject::AttributeInformation * | lowValueAttribute, | ||
| NXOpen::NXObject::AttributeInformation * | highValueAttribute | ||
| ) |
Gets the low and high value of user attribute with given name.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
attributeName attributename lowValueAttribute lowvalueattribute highValueAttribute highvalueattribute
| void NXOpen::CAE::AttributeSelectionRecipe::GetUserAttributes | ( | const char * | attributeName, |
| NXOpen::NXObject::AttributeInformation * | lowValueAttribute, | ||
| NXOpen::NXObject::AttributeInformation * | highValueAttribute | ||
| ) |
Gets the low and high value of user attribute with given name.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
attributeName attributename lowValueAttribute lowvalueattribute highValueAttribute highvalueattribute
| bool NXOpen::CAE::AttributeSelectionRecipe::HasColorAttribute | ( | ) |
Returns the presence of the color attribute.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
| bool NXOpen::CAE::AttributeSelectionRecipe::HasNameAttribute | ( | ) |
Returns the presence of the name attribute.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
| NXString NXOpen::CAE::AttributeSelectionRecipe::NameAttribute | ( | ) |
Returns the name attribute.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
| void NXOpen::CAE::AttributeSelectionRecipe::RemoveColorAttribute | ( | ) |
Removes the color attribute.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
| void NXOpen::CAE::AttributeSelectionRecipe::RemoveNameAttribute | ( | ) |
Removes the name attribute.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
| void NXOpen::CAE::AttributeSelectionRecipe::RemoveUserAttributes | ( | const NXString & | attributeName | ) |
Removes the user attribute with given name.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
attributeName attributename
| void NXOpen::CAE::AttributeSelectionRecipe::RemoveUserAttributes | ( | const char * | attributeName | ) |
Removes the user attribute with given name.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
attributeName attributename
| void NXOpen::CAE::AttributeSelectionRecipe::SetColorAttribute | ( | int | color | ) |
Sets or adds the color attribute.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
color color
| void NXOpen::CAE::AttributeSelectionRecipe::SetNameAttribute | ( | const NXString & | name | ) |
Sets or adds the name attribute.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
name name
| void NXOpen::CAE::AttributeSelectionRecipe::SetNameAttribute | ( | const char * | name | ) |
Sets or adds the name attribute.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
name name
| void NXOpen::CAE::AttributeSelectionRecipe::SetUserAttributes | ( | const NXString & | attributeName, |
| const NXOpen::NXObject::AttributeInformation & | lowValueAttribute, | ||
| const NXOpen::NXObject::AttributeInformation & | highValueAttribute | ||
| ) |
Sets or adds the low and high value of user attribute with given name.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
attributeName attributename lowValueAttribute lowvalueattribute highValueAttribute highvalueattribute
| void NXOpen::CAE::AttributeSelectionRecipe::SetUserAttributes | ( | const char * | attributeName, |
| const NXOpen::NXObject::AttributeInformation & | lowValueAttribute, | ||
| const NXOpen::NXObject::AttributeInformation & | highValueAttribute | ||
| ) |
Sets or adds the low and high value of user attribute with given name.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
attributeName attributename lowValueAttribute lowvalueattribute highValueAttribute highvalueattribute
| void NXOpen::CAE::AttributeSelectionRecipe::SetUserAttributes | ( | bool | setNameAttribute, |
| const NXString & | nameAttribute, | ||
| bool | setColorAttribute, | ||
| int | colorAttribute, | ||
| std::vector< NXString > & | userAttributeNames, | ||
| const std::vector< NXOpen::NXObject::AttributeInformation > & | lowValueAttributes, | ||
| const std::vector< NXOpen::NXObject::AttributeInformation > & | highValueAttributes | ||
| ) |
Convenience method to set multiple attributes at once.
The name and color are optional. It's recommended to use this method in case of setting multiple attributes, to avoid having the recipe resolve multiple times.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
setNameAttribute setnameattribute nameAttribute nameattribute setColorAttribute setcolorattribute colorAttribute colorattribute userAttributeNames userattributenames lowValueAttributes lowvalueattributes highValueAttributes highvalueattributes
| void NXOpen::CAE::AttributeSelectionRecipe::SetUserAttributes | ( | bool | setNameAttribute, |
| const char * | nameAttribute, | ||
| bool | setColorAttribute, | ||
| int | colorAttribute, | ||
| std::vector< NXString > & | userAttributeNames, | ||
| const std::vector< NXOpen::NXObject::AttributeInformation > & | lowValueAttributes, | ||
| const std::vector< NXOpen::NXObject::AttributeInformation > & | highValueAttributes | ||
| ) |
Convenience method to set multiple attributes at once.
The name and color are optional. It's recommended to use this method in case of setting multiple attributes, to avoid having the recipe resolve multiple times.
Created in NX12.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
- Parameters
-
setNameAttribute setnameattribute nameAttribute nameattribute setColorAttribute setcolorattribute colorAttribute colorattribute userAttributeNames userattributenames lowValueAttributes lowvalueattributes highValueAttributes highvalueattributes
The documentation for this class was generated from the following file:
- CAE_AttributeSelectionRecipe.hxx