RARectangularSurface

class ansys.rocky.app.ra_rectangular_surface.RARectangularSurface

Bases: ansys.rocky.app.ra_base_geometry.RABaseGeometry, ansys.rocky.app._ra_orientation_mixin._RAOrientationMixin, ansys.rocky.app.motion._with_movement_mixin._WithMovementMixin

Rocky API “Rectangular Surface” model.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

HasMotionFrame	Whether the geometry is linked to a motion frame.
GetCenter	Get the value of “Center”.
SetCenter	Set the values of “Center”.
GetLength	Get the value of “Length”.
SetLength	Set the value of “Length”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetWidth	Get the value of “Width”.
SetWidth	Set the value of “Width”.

Import detail

from ansys.rocky.app.ra_rectangular_surface import RARectangularSurface

Method detail

classmethod RARectangularSurface.GetWrappedClass() → type[object]

classmethod RARectangularSurface.GetClassName() → str

RARectangularSurface.HasMotionFrame() → bool

Whether the geometry is linked to a motion frame.

Returns:

True if geometry is linked to a motion frame False otherwise

RARectangularSurface.GetCenter(unit: str | None = None) → list[float]

Get the value of “Center”.

Parameters:

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

RARectangularSurface.SetCenter(values: collections.abc.Sequence[str | float], unit: str | None = None) → None

Set the values of “Center”.

Parameters:

• values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.

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

Raises:

RockyApiError – If values doesn’t have exactly 3 elements.

RARectangularSurface.GetLength(unit: str | None = None) → float

Get the value of “Length”.

Parameters:

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

RARectangularSurface.SetLength(value: str | float, unit: str | None = None) → None

Set the value of “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”.

RARectangularSurface.GetName() → str

Get the value of “Name”.

RARectangularSurface.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RARectangularSurface.GetWidth(unit: str | None = None) → float

Get the value of “Width”.

Parameters:

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

RARectangularSurface.SetWidth(value: str | float, unit: str | None = None) → None

Set the value of “Width”.

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”.