RACylinderGroup

class RACylinderGroup

Methods:

Name	Description
AddCurve(curve_name, timesteps, values, unit)	Add a curve to the element with a time-steps domain
GetCenter([unit])
GetCenterAfterMovement(timestep)	Get the Process center position considering the assigned motion.
GetCurve(curve_name[, simulation_name, ...])	Return the curves for the given element and name.
GetCurveNames([simulation_name])	@param simulation_name: unicode
GetCurveNamesAssociation([simulation_name])	Get this element's curve names.
GetElementCurve(element_name, curve_name[, ...])	Return the curves for the given element and name.
GetFinalAngle([unit])
GetInitialAngle([unit])
GetInternalFactor([unit])
GetMotionFrame()
GetNumpyCurve(curve_name[, unit, realization])	Returns a curve as a tuple of numpy arrays (time, property) for the given element and name.
GetOrientation([unit])	Get the orientation angles.
GetOrientationFromAngleAndVector([unit])	Get the current orientation in the form of an angle and a vector.
GetOrientationFromAngles([unit])	Get the current orientation in the form of angles.
GetOrientationFromBasisVector()	Get the current orientation in the form of three basis vectors.
GetRotation([unit])
GetSize([unit])
SetCenter(x, y, z[, unit])	Sets the cylinder X, Y and Z center
SetFinalAngle(final_angle[, unit])	Sets the final hole radius factor of the final given by the size
SetInitialAngle(initial_angle[, unit])	Sets the initial hole radius factor of the external given by the size
SetInternalFactor(internal_factor[, unit])	Sets the internal hole radius factor of the external given by the size
SetMotionFrame(motion_frame)	Assign a Motion Frame to the process.
SetOrientation(rotation[, unit])	The rotation is the angles in x, y and z of the rotation in the given unit.
SetOrientationFromAngleAndVector(angle, vector)	The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector.
SetOrientationFromAngles(rotation[, unit, ...])	The rotation is the angles in x, y and z of the rotation.
SetOrientationFromBasisVector(vector_x, ...)	Sets the rotation using three basis vector and changes the orientation mode to Basis Vector.
SetRotation(x, y, z[, unit])	Sets the cylinder X, Y and Z rotation
SetSize(x, y, z[, unit])	Sets the cylinder X, Y and Z magnitude

AddCurve(curve_name, timesteps, values, unit, realization=None, timesteps_unit=None, initial_date=None)

Add a curve to the element with a time-steps domain

• Parameters:
  • curve_name (unicode or SemanticAssociation) – The curve’s name or semantic association
  • timesteps (list *(*TimeStep ) or list *(*float ) or TimeSet) – The list of time-steps, in such case a initial date can be provided The list of elapsed time as floats, in such case a timesteps_units can be provide or days will be used The curve’s TimeSet
  • values (list *(*float )) – The list of curve image values
  • unit (unicode or Quantity) – The curve image unit or quantity
  • realization (unicode) – An additional keyword to identify the curve realization
  • timesteps_units (unicode) – The elapsed time values unit It should be given if a list of floats is used to define the time-set If not given days are assumed
  • initial_date (tuple *(*int , int , int , int , int , int ) or TimeStep) – The initial date for the time-steps given A tuple with the year, month, day, hour, minute and seconds Or a TimeStep

GetCenter(unit=None)

• Return type: tuple(float, float, float)
• Returns: Returns the X, Y and Z center

GetCenterAfterMovement(timestep: int)

Get the Process center position considering the assigned motion.

• Returns: Returns the X, Y and Z center

GetCurve(curve_name, simulation_name=None, realization=None, time_step=None)

Return the curves for the given element and name.

• Parameters:
  • curve_name (unicode) – The name of the curve.
  • simulation_name (unicode) – An optional parameter for defining the simulation to get the curve from.
  • realization (unicode) – An additional keyword to identify the curve realization
  • time_step (TimeStep) – For transient curves a time-step must be given.

GetCurveNames(simulation_name=None)

@param simulation_name: unicode : An optional parameter for defining the simulation to get the curve from.

• Returns: list(str) The list of curve names

GetCurveNamesAssociation(simulation_name=None)

Get this element’s curve names.

• Parameters: simulation_name (unicode) – The name of the simulation to query the curve names If None is given the current element simulation will be used
• Return type: dict(unicode, ISemanticAssociation)
• Returns: The curve names for this element in the given simulation name

GetElementCurve(element_name, curve_name, simulation_name=None, realization=None, time_step=None)

Return the curves for the given element and name.

• Parameters:
  • element_name (unicode) – The name of the element
  • curve_name (unicode) – The name of the curve
  • simulation_name (unicode) – An optional parameter for defining the simulation to get the curve from.
  • realization (unicode) – An additional keyword to identify the curve realization
  • time_step (TimeStep) – For transient curves a time-step must be given.

GetFinalAngle(unit=None)

• Return final_angle: float The final angle (default dega) of the final given by the size

GetInitialAngle(unit=None)

• Return initial_angle: float The initial angle (default dega) of the external given by the size

GetInternalFactor(unit=None)

• Return internal_factor: float The internal hole radius factor (default %) of the external given by the size

GetMotionFrame()

• Returns: The motion frame set in the process, or None if no motion is set.

GetNumpyCurve(curve_name, unit=None, realization=None)

Returns a curve as a tuple of numpy arrays (time, property) for the given element and name.

GetOrientation(unit: str = 'dega')

Get the orientation angles. For more specific cases, see: “GetOrientationFromAngles”, “GetOrientationFromAngleAndVector” and “GetOrientationFromBasisVector”.

GetOrientationFromAngleAndVector(unit: str = 'dega')

Get the current orientation in the form of an angle and a vector.

GetOrientationFromAngles(unit: str = 'dega')

Get the current orientation in the form of angles.

GetOrientationFromBasisVector()

Get the current orientation in the form of three basis vectors.

GetRotation(unit=None)

• Return type: tuple(float, float, float)
• Returns: Returns the X, Y and Z cylinder rotation

GetSize(unit: str | None = None)

• Return type: tuple(float, float, float)
• Returns: Returns the X, Y and Z cylinder magnitude

SetCenter(x: float, y: float, z: float, unit: str | None = None)

Sets the cylinder X, Y and Z center

• Parameters:
  • x – float The center X coordinate
  • y – The center Y coordinate
  • z – The center Z coordinate
  • unit (str *|*None) – The unit of the given values or None if given in meters (m)

SetFinalAngle(final_angle, unit=None)

Sets the final hole radius factor of the final given by the size

• Parameters:
  • final_angle – float The final angle
  • unit (str *|*None) – The unit of the given value or None if given in degrees (dega)

SetInitialAngle(initial_angle, unit=None)

Sets the initial hole radius factor of the external given by the size

• Parameters:
  • initial_angle – float The initial angle
  • unit (str *|*None) – The unit of the given value or None if given in degrees (dega)

SetInternalFactor(internal_factor, unit=None)

Sets the internal hole radius factor of the external given by the size

• Parameters:
  • internal_factor – float The internal factor
  • unit (str *|*None) – The unit of the given value or None if given in percentage (%)

SetMotionFrame(motion_frame: RAMotionFrame | str | None)

Assign a Motion Frame to the process.

• Parameters: motion_frame – Either the API object or its name.

SetOrientation(rotation: tuple[float, float, float], unit: str = 'dega')

The rotation is the angles in x, y and z of the rotation in the given unit. For more specific methods, see: “SetOrientationFromAngles”, “SetOrientationFromAngleAndVector” and “SetOrientationFromBasisVector”.

SetOrientationFromAngleAndVector(angle: float, vector: tuple[float, float, float], unit: str = 'dega')

The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector.

SetOrientationFromAngles(rotation: tuple[float, float, float], unit: str = 'dega', local_angles: bool = True, order: str = 'XYZ')

The rotation is the angles in x, y and z of the rotation. The default unit is dega. Additionally, local_angles can be used as well an order of the values via kwargs.

SetOrientationFromBasisVector(vector_x: tuple[float, float, float], vector_y: tuple[float, float, float], vector_z: tuple[float, float, float])

Sets the rotation using three basis vector and changes the orientation mode to Basis Vector.

SetRotation(x, y, z, unit=None)

Sets the cylinder X, Y and Z rotation

• Parameters:
  • x – float The X rotation
  • y – The Y rotation
  • z – The Z rotation
  • unit (str *|*None) – The unit of the given values or None if given in degrees (dega)

SetSize(x: float, y: float, z: float, unit: str | None = None)

Sets the cylinder X, Y and Z magnitude

• Parameters:
  • x – float The X magnitude
  • y – The Y magnitude
  • z – The Z magnitude
  • unit (str *|*None) – The unit of the given values or None if given in meters (m)