Skip to main content

AVxcelerate Asset Preparation API 2023 R2

asset_preparation::v1::surface_source::SurfaceSourcePreparation Class Reference

Last update: 16.07.2025

Surface Source Preparation Service. More...

Public Member Functions

CreateSurfaceSourceResponse CreateSurfaceSource (CreateSurfaceSourceRequest)
 
GetSurfaceSourceResponse GetSurfaceSource (GetSurfaceSourceRequest)
 
ListSurfaceSourcesResponse ListSurfaceSources (google::protobuf::Empty)
 
UpdateSurfaceSourceResponse UpdateSurfaceSource (UpdateSurfaceSourceRequest)
 
DeleteSurfaceSourceResponse DeleteSurfaceSource (DeleteSurfaceSourceRequest)
 

Detailed Description

Surface Source Preparation Service.

This service is used to create, edit and manage surface sources.

Member Function Documentation

◆ CreateSurfaceSource()

CreateSurfaceSourceResponse asset_preparation::v1::surface_source::SurfaceSourcePreparation::CreateSurfaceSource ( CreateSurfaceSourceRequest  )

Creates a new surface source with an optional name and properties.

Note
If unspecified, default values are used.

Returns the identifier of the created surface source.

◆ DeleteSurfaceSource()

DeleteSurfaceSourceResponse asset_preparation::v1::surface_source::SurfaceSourcePreparation::DeleteSurfaceSource ( DeleteSurfaceSourceRequest  )

Deletes a surface source, given its identifier.

◆ GetSurfaceSource()

GetSurfaceSourceResponse asset_preparation::v1::surface_source::SurfaceSourcePreparation::GetSurfaceSource ( GetSurfaceSourceRequest  )

Gets the properties of a surface source, given its identifier.

Returns the surface source or display source properties.

◆ ListSurfaceSources()

ListSurfaceSourcesResponse asset_preparation::v1::surface_source::SurfaceSourcePreparation::ListSurfaceSources ( google::protobuf::Empty  )

Lists all the created surface sources.

Returns the identifiers and names of the surface sources.

◆ UpdateSurfaceSource()

UpdateSurfaceSourceResponse asset_preparation::v1::surface_source::SurfaceSourcePreparation::UpdateSurfaceSource ( UpdateSurfaceSourceRequest  )

Edits the properties of a surface source, given its identifier.

Note
Names must be unique amongst surface sources.

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

Connect with Ansys