RABaseConveyor

class ansys.rocky.app.conveyors.ra_base_conveyor.RABaseConveyor

Bases: ansys.rocky.app.ra_base_geometry.RABaseGeometry

Base class for Rocky API conveyor models.

Overview

Methods

GetBeltProfileName	Get the name of the belt profile.
GetBeltProfile	rtype: ApiElementItem
SetBeltProfile	Set the belt profile object through its name as shown in the UI.
GetValidBeltProfileNames	Return a list with possible values for belt profile.

Import detail

from ansys.rocky.app.conveyors.ra_base_conveyor import RABaseConveyor

Method detail

RABaseConveyor.GetBeltProfileName()

Get the name of the belt profile.

Return type:

str

Returns:

A string describing the type of belt profile. The returned value will be one of the strings in the “Belt Profile” drop-down menu in the UI.

RABaseConveyor.GetBeltProfile()

Return type:

ApiElementItem

Returns:

The API object that wraps the current belt profile.

RABaseConveyor.SetBeltProfile(belt_profile_name)

Set the belt profile object through its name as shown in the UI.

Parameters:

belt_profile_name (str) – Accepted values are the strings in the “Belt Profile” dropdown menu in the UI.

Return type:

ApiElementItem

Returns:

The PrePost Scripting wrapper representing the belt profile.

RABaseConveyor.GetValidBeltProfileNames()

Return a list with possible values for belt profile.

Return type:

list(str)

Returns:

A list of accepted values for SetBeltProfile().