RABaseMotionFrame

class ansys.rocky.app.motion.ra_base_motion.RABaseMotionFrame(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Base class for Api representations of MotionFrames and MotionFrameSources. Provides methods to create, iterate and remove motion frames.

Overview

Methods

NewFrame	Creates a new motion frame.
NewConeCrusherFrame	Creates a new cone crusher frame.
IterMotionFrames	Iterates over all the motion frames available (recursively).
GetMotionFrame	Get a specific motion frame given its name.
RemoveFrame	Removes a previously-created motion frame.
GetParentMotionFrame	Gets the parent motion frame.

Import detail

from ansys.rocky.app.motion.ra_base_motion import RABaseMotionFrame

Method detail

RABaseMotionFrame.NewFrame() → ansys.rocky.app.motion.ra_motion_frame.RAMotionFrame

Creates a new motion frame.

RABaseMotionFrame.NewConeCrusherFrame() → ansys.rocky.app.motion.ra_cone_crusher_frame.RAConeCrusherFrame

Creates a new cone crusher frame.

Return type:

RAConeCrusherFrame

RABaseMotionFrame.IterMotionFrames() → Iterator[ansys.rocky.app.motion.ra_motion_frame.RAMotionFrame | ansys.rocky.app.motion.ra_cone_crusher_frame.RAConeCrusherFrame]

Iterates over all the motion frames available (recursively).

Return iter(RAMotionFrame):

RABaseMotionFrame.GetMotionFrame(frame_name: str) → ansys.rocky.app.motion.ra_motion_frame.RAMotionFrame | ansys.rocky.app.motion.ra_cone_crusher_frame.RAConeCrusherFrame

Get a specific motion frame given its name.

Parameters:

frame_name (unicode)

Return type:

RAMotionFrame

RABaseMotionFrame.RemoveFrame(motion_frame: ansys.rocky.app.motion.ra_motion_frame.RAMotionFrame | ansys.rocky.app.motion.ra_cone_crusher_frame.RAConeCrusherFrame) → None

Removes a previously-created motion frame.

Parameters:

motion_frame (RAMotionFrame or RAConeCrusherFrame)

RABaseMotionFrame.GetParentMotionFrame() → ansys.rocky.app.motion.ra_motion_frame.RAMotionFrame | None

Gets the parent motion frame. If the Motion Frame is a RAMotionFrameSource it returns None.

Return type:

RAMotionFrame