MaterialSpecificationBuilder Class¶
-
class
NXOpen.Annotations.MaterialSpecificationBuilder¶ Bases:
NXOpen.Annotations.PmiAttributeBuilderRepresents a
NXOpen.Annotations.MaterialSpecificationbuilderTo create a new instance of this class, use
NXOpen.Annotations.PmiAttributeCollection.CreateMaterialSpecificationBuilder()New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| AssociatedObjects | Returns the NXOpen.Annotations.AssociatedObjectsBuilder for the annotation |
| Attribute | Returns or sets the NXOpen.Annotations.Pmi for this annotation |
| AvailableMaterial | Returns or sets the revision |
| BusinessModifier | Returns or sets the business modifier |
| Category | Returns or sets the category |
| KnowledgeFusionClassName | Returns or sets the knowledge fusion class name file, the default class is UG provided pmi KF class |
| Leader | Returns the NXOpen.Annotations.LeaderBuilder for the annotation |
| MaterialType | Returns or sets the material type |
| Origin | Returns the NXOpen.Annotations.OriginBuilder for the annotation |
| Revision | Returns or sets the revision |
| Style | Returns the NXOpen.Annotations.StyleBuilder for the annotation |
| Tag | Returns the Tag for this object. |
| Title | Returns or sets the str title |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetAttributeValues | Returns the attribute values |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetMaterialProperties | Returns the material properties |
| GetNomenclature | Returns the nomenclature |
| GetObject | Returns the object currently being edited by this builder. |
| GetOpenField | Returns the open field |
| SetAttributeValues | Sets the attribute values |
| SetMaterialProperties | Sets the material properties |
| SetNomenclature | Sets the nomenclature |
| SetOpenField | Sets the open field |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AvailableMaterial¶
-
MaterialSpecificationBuilder.AvailableMaterial¶ Returns or sets the revision
-------------------------------------Getter Method
Signature
AvailableMaterialReturns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AvailableMaterialParameters: availableMaterial (str) – New in version NX6.0.0.
License requirements: None.
Category¶
-
MaterialSpecificationBuilder.Category¶ Returns or sets the category
-------------------------------------Getter Method
Signature
CategoryReturns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CategoryParameters: category (str) – New in version NX6.0.0.
License requirements: None.
MaterialType¶
-
MaterialSpecificationBuilder.MaterialType¶ Returns or sets the material type
-------------------------------------Getter Method
Signature
MaterialTypeReturns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MaterialTypeParameters: materialType (str) – New in version NX6.0.0.
License requirements: None.
Revision¶
-
MaterialSpecificationBuilder.Revision¶ Returns or sets the revision
-------------------------------------Getter Method
Signature
RevisionReturns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RevisionParameters: revision (str) – New in version NX6.0.0.
License requirements: None.
Title¶
-
MaterialSpecificationBuilder.Title¶ Returns or sets the str title
-------------------------------------Getter Method
Signature
TitleReturns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TitleParameters: title (str) – New in version NX6.0.0.
License requirements: None.
Method Detail¶
GetMaterialProperties¶
-
MaterialSpecificationBuilder.GetMaterialProperties¶ Returns the material properties
Signature
GetMaterialProperties()Returns: Return type: list of str New in version NX6.0.0.
License requirements: None.
GetNomenclature¶
-
MaterialSpecificationBuilder.GetNomenclature¶ Returns the nomenclature
Signature
GetNomenclature()Returns: Return type: list of str New in version NX6.0.0.
License requirements: None.
GetOpenField¶
-
MaterialSpecificationBuilder.GetOpenField¶ Returns the open field
Signature
GetOpenField()Returns: Return type: list of str New in version NX6.0.0.
License requirements: None.
SetMaterialProperties¶
-
MaterialSpecificationBuilder.SetMaterialProperties¶ Sets the material properties
Signature
SetMaterialProperties(materialProperties)Parameters: materialProperties (list of str) – New in version NX6.0.0.
License requirements: None.
SetNomenclature¶
-
MaterialSpecificationBuilder.SetNomenclature¶ Sets the nomenclature
Signature
SetNomenclature(nomenclature)Parameters: nomenclature (list of str) – New in version NX6.0.0.
License requirements: None.
SetOpenField¶
-
MaterialSpecificationBuilder.SetOpenField¶ Sets the open field
Signature
SetOpenField(openField)Parameters: openField (list of str) – New in version NX6.0.0.
License requirements: None.
Validate¶
-
MaterialSpecificationBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.