FamilyAttribute Class¶
-
class
NXOpen.PartFamily.FamilyAttribute¶ Bases:
NXOpen.NXObjectThis class represents a part family attribute
Use
PartFamily.TemplateManager.GetPartFamilyAttribute()to get an instance of this class. This method will not create a new part family attribute. It will only return attribute that is already created. To create a new attribute, usePartFamily.TemplateManager.AddToChosenAttributes(), which will create an attribute and add to chosen attributes list on template manager. It is not allowed to create a standalone attribute that is not added to chosen attributes list.New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| IsOccurrence | Returns whether this object is an occurrence or not. |
| IsOptional | Returns a value indicating whether the attribute is an optional attribute. |
| IsRequired | Returns a value indicating whether the attribute is a required attribute. |
| JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
| Name | Returns the name of the given attribute |
| OwningComponent | Returns the owning component, if this object is an occurrence. |
| OwningPart | Returns the owning part of this object |
| Prototype | Returns the prototype of this object if it is an occurrence. |
| Tag | Returns the Tag for this object. |
| Type | Returns the type of the given attribute |
| Value | Returns the value of the given attribute |
| Version | Returns the version of the given attribute |
Methods¶
| Method | Description |
|---|---|
| CreateAttributeIterator | Create an attribute iterator |
| DeleteAllAttributesByType | Deletes all attributes of a specific type. |
| DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
| DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
| DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator |
| FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
| GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
| GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
| GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetIntegerAttribute | Gets an integer attribute by title. |
| GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
| GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
| GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
| GetRealAttribute | Gets a real attribute by title. |
| GetRealUserAttribute | Gets a real attribute by Title and array Index. |
| GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
| GetStringAttribute | Gets a string attribute value by title. |
| GetStringUserAttribute | Gets a string attribute by Title and array Index. |
| GetTimeAttribute | Gets a time attribute by title. |
| GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
| GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
| GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator. |
| GetUserAttributeLock | Determine the lock of the given attribute. |
| GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
| GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
| GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. |
| GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
| HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
| Prints a representation of this object to the system log file. | |
| SetAttribute | Creates or modifies an integer attribute. |
| SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
| SetName | Sets the custom name of the object. |
| SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object. |
| SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
| SetTimeAttribute | Creates or modifies a time attribute. |
| SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
| SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
| SetUserAttributeLock | Lock or unlock the given attribute. |
Enumerations¶
| FamilyAttributeAttrType Enumeration | The part family attribute types. |
Property Detail¶
IsOccurrence¶
-
FamilyAttribute.IsOccurrence¶ Returns whether this object is an occurrence or not.
-------------------------------------Getter Method
Signature
IsOccurrenceReturns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
IsOptional¶
-
FamilyAttribute.IsOptional¶ Returns a value indicating whether the attribute is an optional attribute.
This could be an optional creation non key attribute or an optional key attribute
-------------------------------------Getter Method
Signature
IsOptionalReturns: Return type: bool New in version NX10.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
IsRequired¶
-
FamilyAttribute.IsRequired¶ Returns a value indicating whether the attribute is a required attribute.
This could be a required creation non key attribute or a required key attribute
-------------------------------------Getter Method
Signature
IsRequiredReturns: Return type: bool New in version NX10.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
JournalIdentifier¶
-
FamilyAttribute.JournalIdentifier¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------Getter Method
Signature
JournalIdentifierReturns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
FamilyAttribute.Name¶ Returns the name of the given attribute
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
OwningComponent¶
-
FamilyAttribute.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponentReturns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
FamilyAttribute.OwningPart¶ Returns the owning part of this object
-------------------------------------Getter Method
Signature
OwningPartReturns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
FamilyAttribute.Prototype¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------Getter Method
Signature
PrototypeReturns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
Type¶
-
FamilyAttribute.Type¶ Returns the type of the given attribute
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.PartFamily.FamilyAttributeAttrTypeNew in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
FindObject¶
-
FamilyAttribute.FindObject¶ Finds the
NXOpen.NXObjectwith the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
Print¶
-
FamilyAttribute.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetName¶
-
FamilyAttribute.SetName¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)Parameters: name (str) – New in version NX3.0.0.
License requirements: None.