RAFiveRollsBeltProfile#

class ansys.rocky.app.conveyors.ra_five_rolls_belt_profile.RAFiveRollsBeltProfile(id: str, model_id: str | None = None)#

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky API for a Five Rolls Belt Profile model.

Overview#

GetWrappedClass

GetClassName

GetCenterRollLength

Get the value of “Center Roll Length”.

SetCenterRollLength

Set the value of “Center Roll Length”.

GetLastRollAngle

Get the value of “Last Roll Angle”.

SetLastRollAngle

Set the value of “Last Roll Angle”.

GetLowerCornerRadius

Get the value of “Lower Corner Radius”.

SetLowerCornerRadius

Set the value of “Lower Corner Radius”.

GetSideRollLength

Get the value of “Side Roll Length”.

SetSideRollLength

Set the value of “Side Roll Length”.

GetTroughingAngle

Get the value of “Troughing Angle”.

SetTroughingAngle

Set the value of “Troughing Angle”.

GetUpperCornerRadius

Get the value of “Upper Corner Radius”.

SetUpperCornerRadius

Set the value of “Upper Corner Radius”.

GetUse0223RatioForRollLengths

Get the value of “Use 0223 Ratio For Roll Lengths”.

SetUse0223RatioForRollLengths

Set the value of “Use 0223 Ratio For Roll Lengths”.

EnableUse0223RatioForRollLengths

Set the value of “Use 0223 Ratio For Roll Lengths” to True.

DisableUse0223RatioForRollLengths

Set the value of “Use 0223 Ratio For Roll Lengths” to False.

IsUse0223RatioForRollLengthsEnabled

Check if the “Use 0223 Ratio For Roll Lengths” is enabled.

GetMaterial

Get the “Material”.

SetMaterial

Set the “Material”.

GetAvailableMaterials

Get all available Materials.

Import detail#

from ansys.rocky.app.conveyors.ra_five_rolls_belt_profile import RAFiveRollsBeltProfile

Method detail#

classmethod RAFiveRollsBeltProfile.GetWrappedClass()#
classmethod RAFiveRollsBeltProfile.GetClassName()#
RAFiveRollsBeltProfile.GetCenterRollLength(unit: str | None = None) → float#

Get the value of “Center Roll Length”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RAFiveRollsBeltProfile.SetCenterRollLength(value: str | float, unit: str | None = None) → None#

Set the value of “Center Roll Length”.

Parameters:

  • value – The value to set. This value can be an expression with input variables or float type.

  • unit – The unit for value. If no unit is provided, value is assumed to be in “m”.

RAFiveRollsBeltProfile.GetLastRollAngle(unit: str | None = None) → float#

Get the value of “Last Roll Angle”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “rad”.

RAFiveRollsBeltProfile.SetLastRollAngle(value: str | float, unit: str | None = None) → None#

Set the value of “Last Roll Angle”.

Parameters:

  • value – The value to set. This value can be an expression with input variables or float type.

  • unit – The unit for value. If no unit is provided, value is assumed to be in “rad”.

RAFiveRollsBeltProfile.GetLowerCornerRadius(unit: str | None = None) → float#

Get the value of “Lower Corner Radius”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RAFiveRollsBeltProfile.SetLowerCornerRadius(value: str | float, unit: str | None = None) → None#

Set the value of “Lower Corner Radius”.

Parameters:

  • value – The value to set. This value can be an expression with input variables or float type.

  • unit – The unit for value. If no unit is provided, value is assumed to be in “m”.

RAFiveRollsBeltProfile.GetSideRollLength(unit: str | None = None) → float#

Get the value of “Side Roll Length”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RAFiveRollsBeltProfile.SetSideRollLength(value: str | float, unit: str | None = None) → None#

Set the value of “Side Roll Length”.

Parameters:

  • value – The value to set. This value can be an expression with input variables or float type.

  • unit – The unit for value. If no unit is provided, value is assumed to be in “m”.

RAFiveRollsBeltProfile.GetTroughingAngle(unit: str | None = None) → float#

Get the value of “Troughing Angle”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “dega”.

RAFiveRollsBeltProfile.SetTroughingAngle(value: str | float, unit: str | None = None) → None#

Set the value of “Troughing Angle”.

Parameters:

  • value – The value to set. This value can be an expression with input variables or float type.

  • unit – The unit for value. If no unit is provided, value is assumed to be in “dega”.

RAFiveRollsBeltProfile.GetUpperCornerRadius(unit: str | None = None) → float#

Get the value of “Upper Corner Radius”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RAFiveRollsBeltProfile.SetUpperCornerRadius(value: str | float, unit: str | None = None) → None#

Set the value of “Upper Corner Radius”.

Parameters:

  • value – The value to set. This value can be an expression with input variables or float type.

  • unit – The unit for value. If no unit is provided, value is assumed to be in “m”.

RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths() → bool#

Get the value of “Use 0223 Ratio For Roll Lengths”.

RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths(value: bool) → None#

Set the value of “Use 0223 Ratio For Roll Lengths”.

Parameters:

value – The value to set.

RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths() → None#

Set the value of “Use 0223 Ratio For Roll Lengths” to True.

RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths() → None#

Set the value of “Use 0223 Ratio For Roll Lengths” to False.

RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled() → bool#

Check if the “Use 0223 Ratio For Roll Lengths” is enabled.

RAFiveRollsBeltProfile.GetMaterial()#

Get the “Material”.

Return type:

RASolidMaterial

RAFiveRollsBeltProfile.SetMaterial(value) → None#

Set the “Material”.

:param unicode, RASolidMaterial value:

Either the API object wrapping the desired entity or its name.

RAFiveRollsBeltProfile.GetAvailableMaterials()#

Get all available Materials.

Return type:

List[RASolidMaterial] A list of RASolidMaterial.