RAConeCrusherFrame#

class ansys.rocky.app.motion.ra_cone_crusher_frame.RAConeCrusherFrame(id: str, model_id: str | None = None)#

Bases: ansys.rocky.app.motion.ra_base_motion.RABaseMotionFrame

Rocky PrePost Scripting wrapper for a cone crusher frame.

The class contains methods to configure a cone crusher frame. There are some options to retrieve a specific RAConeCrusherFrame in a project from a RAStudy, a RAMotionFrameSource, another RAConeCrusherFrame or a RAMotionFrame:

# From the RAStudy
motion_frame = study.GetElement('')

# From the RAMotionFrameSource
frame_source = study.GetMotionFrameSource()
motion_frame = frame_source.GetMotionFrame('')

# From a "parent" motion frame
frame_1 = study.GetElement('')
frame_2 = frame_1.GetMotionFrame('')

Motion frames can be created on the “root” of the project’s cone crusher frames (the source returned in RAStudy.GetMotionFrameSource()), or as a ‘child’ frame of a pre-existing cone crusher frame:

frame_source = study.GetMotionFrameSource()

# Create a motion frame with no parent frame
frame_1 = frame_source.NewConeCrusherFrame()
# Configure this new frame frame_1
frame_1.SetInitialOrientation(...)
frame_1.SetPivotPoint(...)

# Create a new frame, as a child of `frame_1`
frame_2 = frame_1.NewConeCrusherFrame()
# Configure this new frame frame_2
frame_2.SetInitialOrientation(...)
# ... configure motions, etc.

Overview#

GetWrappedClass

GetClassName

GetInitialOrientation

Get the value of “Initial Orientation”.

SetInitialOrientation

Set the values of “Initial Orientation”.

GetPivotPoint

Get the value of “Pivot Point”.

SetPivotPoint

Set the values of “Pivot Point”.

GetRotationAxis

Get the value of “Rotation Axis”.

SetRotationAxis

Set the values of “Rotation Axis”.

GetRotationalVelocity

Get the value of “Rotational Velocity”.

SetRotationalVelocity

Set the value of “Rotational Velocity”.

GetStartTime

Get the value of “Start Time”.

SetStartTime

Set the value of “Start Time”.

GetStopTime

Get the value of “Stop Time”.

SetStopTime

Set the value of “Stop Time”.

Import detail#

from ansys.rocky.app.motion.ra_cone_crusher_frame import RAConeCrusherFrame

Method detail#

classmethod RAConeCrusherFrame.GetWrappedClass()#
classmethod RAConeCrusherFrame.GetClassName()#
RAConeCrusherFrame.GetInitialOrientation(unit: str | None = None) → list[float]#

Get the value of “Initial Orientation”.

Parameters:

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

RAConeCrusherFrame.SetInitialOrientation(values: collections.abc.Sequence[str | float], unit: str | None = None) → None#

Set the values of “Initial Orientation”.

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.

RAConeCrusherFrame.GetPivotPoint(unit: str | None = None) → list[float]#

Get the value of “Pivot Point”.

Parameters:

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

RAConeCrusherFrame.SetPivotPoint(values: collections.abc.Sequence[str | float], unit: str | None = None) → None#

Set the values of “Pivot Point”.

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.

RAConeCrusherFrame.GetRotationAxis(unit: str | None = None) → list[float]#

Get the value of “Rotation Axis”.

Parameters:

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

RAConeCrusherFrame.SetRotationAxis(values: collections.abc.Sequence[str | float], unit: str | None = None) → None#

Set the values of “Rotation Axis”.

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.

RAConeCrusherFrame.GetRotationalVelocity(unit: str | None = None) → float#

Get the value of “Rotational Velocity”.

Parameters:

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

RAConeCrusherFrame.SetRotationalVelocity(value: str | float, unit: str | None = None) → None#

Set the value of “Rotational Velocity”.

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

RAConeCrusherFrame.GetStartTime(unit: str | None = None) → float#

Get the value of “Start Time”.

Parameters:

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

RAConeCrusherFrame.SetStartTime(value: str | float, unit: str | None = None) → None#

Set the value of “Start Time”.

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

RAConeCrusherFrame.GetStopTime(unit: str | None = None) → float#

Get the value of “Stop Time”.

Parameters:

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

RAConeCrusherFrame.SetStopTime(value: str | float, unit: str | None = None) → None#

Set the value of “Stop Time”.

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