PhysicalMaterialBuilder Class¶
-
class
NXOpen.
PhysicalMaterialBuilder
¶ Bases:
NXOpen.ItemCacheMappedEntityBuilder
Represents a
NXOpen.PhysicalMaterial
builderTo create a new instance of this class, use
NXOpen.PhysicalMaterialCollection.CreatePhysicalMaterialBuilder()
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AddToMaterialLibraryToggle | Returns or sets the add_to_material_library_toggle value. |
Description | Returns or sets the material description value. |
Id | Returns or sets the material id value. |
ItemDescription | Returns or sets the description value. |
ItemId | Returns or sets the id value. |
ItemName | Returns or sets the name value. |
ItemPropertyTable | Returns the property table associated with the object |
MaterialLibrary | Returns or sets the material library value. |
Name | Returns or sets the material name value. |
PropertyTable | Returns the property table associated with the material object |
Tag | Returns the Tag for this object. |
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. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
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¶
AddToMaterialLibraryToggle¶
-
PhysicalMaterialBuilder.
AddToMaterialLibraryToggle
¶ Returns or sets the add_to_material_library_toggle value.
If set to true, the material to be added to the specified material library upon commit
-------------------------------------
Getter Method
Signature
AddToMaterialLibraryToggle
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AddToMaterialLibraryToggle
Parameters: toggleValue (bool) – New in version NX6.0.0.
License requirements: None.
Description¶
-
PhysicalMaterialBuilder.
Description
¶ Returns or sets the material description value.
-------------------------------------
Getter Method
Signature
Description
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Description
Parameters: description (str) – New in version NX6.0.0.
License requirements: None.
Id¶
-
PhysicalMaterialBuilder.
Id
¶ Returns or sets the material id value.
-------------------------------------
Getter Method
Signature
Id
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Id
Parameters: id (int) – New in version NX7.5.0.
License requirements: None.
MaterialLibrary¶
-
PhysicalMaterialBuilder.
MaterialLibrary
¶ Returns or sets the material library value.
The material libary is the file name where you would like to save this material upon commit
-------------------------------------
Getter Method
Signature
MaterialLibrary
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaterialLibrary
Parameters: name (str) – New in version NX6.0.0.
License requirements: None.
Name¶
-
PhysicalMaterialBuilder.
Name
¶ Returns or sets the material name value.
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Name
Parameters: name (str) – New in version NX6.0.0.
License requirements: None.
PropertyTable¶
-
PhysicalMaterialBuilder.
PropertyTable
¶ Returns the property table associated with the material object
-------------------------------------
Getter Method
Signature
PropertyTable
Returns: property table Return type: NXOpen.CAE.PropertyTable
New in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
PhysicalMaterialBuilder.
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.