Skip to main content

AVxcelerate Asset Preparation API 2024 R2

asset_preparation::v3::material::MaterialPreparation Class Reference

Last update: 16.07.2025

Material Preparation Service. More...

Public Member Functions

CreateMaterialResponse CreateMaterial (CreateMaterialRequest)
 
GetMaterialResponse GetMaterial (GetMaterialRequest)
 
ListMaterialsResponse ListMaterials (google::protobuf::Empty)
 
UpdateMaterialResponse UpdateMaterial (UpdateMaterialRequest)
 
DeleteMaterialResponse DeleteMaterial (DeleteMaterialRequest)
 
CreateMaterialStateResponse CreateMaterialState (CreateMaterialStateRequest)
 
GetMaterialStateResponse GetMaterialState (GetMaterialStateRequest)
 
UpdateMaterialStateResponse UpdateMaterialState (UpdateMaterialStateRequest)
 
DeleteMaterialStateResponse DeleteMaterialState (DeleteMaterialStateRequest)
 

Detailed Description

Material Preparation Service.

This service is used to create, edit and manage materials.

Member Function Documentation

◆ CreateMaterial()

CreateMaterialResponse asset_preparation::v3::material::MaterialPreparation::CreateMaterial ( CreateMaterialRequest  )

Creates a new material with optional properties.

Note
Names must be unique amongst sibling materials.
If some properties are not specified, default values are used and no dielectric properties are defined.

Returns the information about the created material.

◆ GetMaterial()

GetMaterialResponse asset_preparation::v3::material::MaterialPreparation::GetMaterial ( GetMaterialRequest  )

Gets the properties of a material, given its identifier.

Returns the material properties.

◆ ListMaterials()

ListMaterialsResponse asset_preparation::v3::material::MaterialPreparation::ListMaterials ( google::protobuf::Empty  )

Lists all the stored materials.

Returns the identifiers and names of the stored materials.

◆ UpdateMaterial()

UpdateMaterialResponse asset_preparation::v3::material::MaterialPreparation::UpdateMaterial ( UpdateMaterialRequest  )

Edits the properties of a material, given its identifier.

Note
Names must be unique amongst materials.

◆ DeleteMaterial()

DeleteMaterialResponse asset_preparation::v3::material::MaterialPreparation::DeleteMaterial ( DeleteMaterialRequest  )

Deletes a material, given its identifier.

◆ CreateMaterialState()

CreateMaterialStateResponse asset_preparation::v3::material::MaterialPreparation::CreateMaterialState ( CreateMaterialStateRequest  )

Creates a new material state with optional properties.

Note
Names must be unique amongst sibling material states.
"Default" name is reserved.
If some properties are not specified, default values are used and no dielectric properties are defined.

Returns the information about the created material state.

◆ GetMaterialState()

GetMaterialStateResponse asset_preparation::v3::material::MaterialPreparation::GetMaterialState ( GetMaterialStateRequest  )

Gets the properties of a material state, given the parent material identifier and the state name.

Returns the material state properties.

◆ UpdateMaterialState()

UpdateMaterialStateResponse asset_preparation::v3::material::MaterialPreparation::UpdateMaterialState ( UpdateMaterialStateRequest  )

Edits the properties of a state, given the parent material identifier and the state name.

Note
Names must be unique amongst sibling material states.
"Default" name is reserved.

◆ DeleteMaterialState()

DeleteMaterialStateResponse asset_preparation::v3::material::MaterialPreparation::DeleteMaterialState ( DeleteMaterialStateRequest  )

Deletes a material state, given the parent material identifier and the state name.


The documentation for this class was generated from the following file:
  • material.proto

Connect with Ansys