=============================
Actuator (hwx.inspire.motion)
=============================

Creates an Actuator.

Actuators drive parts in a translational manner, and can be defined in terms
of displacement, velocity, acceleration, or force.
It's a convenient way to apply a time-dependent force to your model.

Inherits:
  - :ref:`MotionConnector (hwx.inspire.motion)`

----------
Attributes
----------

  +---------------------------------+---------------------------------+---------------------------------+
  | active_: Bool                   | arrowScale_: Double             | averageValue_: EnumUnion (type) |
  +---------------------------------+---------------------------------+---------------------------------+
  | baseScale_: Double              | clevisPinHoles_: Attribute      | coaxial_: Bool                  |
  +---------------------------------+---------------------------------+---------------------------------+
  | coaxialJoint_: Enum             | connectionRadius_: Double       | controller_: Bool               |
  +---------------------------------+---------------------------------+---------------------------------+
  | controllerType_: Enum           | direction_: Direction           | dtValue_: Double                |
  +---------------------------------+---------------------------------+---------------------------------+
  | duration_: Double               | dwellTime_: Double              | entity1_: Attribute             |
  +---------------------------------+---------------------------------+---------------------------------+
  | entity2_: Attribute             | finalFrequency_: Double         | flipAxis_: Bool                 |
  +---------------------------------+---------------------------------+---------------------------------+
  | frequency_: Double              | function_: Enum                 | icVelocity_: Double             |
  +---------------------------------+---------------------------------+---------------------------------+
  | initialFrequency_: Double       | joint_: Attribute               | kd_: Double                     |
  +---------------------------------+---------------------------------+---------------------------------+
  | ki_: Double                     | kp_: Double                     | lineOfSight_: Bool              |
  +---------------------------------+---------------------------------+---------------------------------+
  | location1_: Location            | location2_: Location            | locked_: Bool                   |
  +---------------------------------+---------------------------------+---------------------------------+
  | mountColor_: Color              | mountPivotAxis_: Direction      | mountPivotType_: Enum           |
  +---------------------------------+---------------------------------+---------------------------------+
  | name_: Attribute                | parts_: Attribute               | penalty_: Double                |
  +---------------------------------+---------------------------------+---------------------------------+
  | penalty1_: Double               | phaseShift_: Double             | profile_: Attribute             |
  +---------------------------------+---------------------------------+---------------------------------+
  | reverseDirection_: Bool         | rotateWithPart_: Bool           | rotation_: Double               |
  +---------------------------------+---------------------------------+---------------------------------+
  | shaftColor_: Color              | shaftRadius_: Double            | shaftRotation_: Double          |
  +---------------------------------+---------------------------------+---------------------------------+
  | span_: Double                   | spline_: EnumUnion (type)       | splineMethod_: Enum             |
  +---------------------------------+---------------------------------+---------------------------------+
  | startTime_: Double              | stepOff_: Double                | stepOn_: Double                 |
  +---------------------------------+---------------------------------+---------------------------------+
  | sweepInterval_: Double          | type_: Enum                     | userFunction_: Attribute        |
  +---------------------------------+---------------------------------+---------------------------------+
  | userFunctionScale_: Double      | userFunctionUnits_: Attribute   | value_: EnumUnion (type)        |
  +---------------------------------+---------------------------------+---------------------------------+
  | visible_: Bool                  | writePlantSignals_: Bool        |                                 |
  +---------------------------------+---------------------------------+---------------------------------+

----------
Properties
----------

  +------------------+------------------+------------------+
  | baseRotation_    | connectorMode_   | mountConnection_ |
  +------------------+------------------+------------------+
  | mountLocation_   | shaftConnection_ | shaftDirection_  |
  +------------------+------------------+------------------+
  | shaftLocation_   |                                     |
  +------------------+-------------------------------------+

--------------
Public Methods
--------------

  +--------------------------------------------------+
  | classmethod areFeaturesASlot_ (cls, obj, planes) |
  +--------------------------------------------------+
  | classmethod isValidCandidate_ (cls, obj)         |
  +--------------------------------------------------+
  | getShaftLength_ (self)                           |
  +--------------------------------------------------+
  | getShaftRadius_ (self)                           |
  +--------------------------------------------------+
  | getTranslationalValue_ (self)                    |
  +--------------------------------------------------+
  | isCoaxial_ (self)                                |
  +--------------------------------------------------+
  | isLineOfSight_ (self)                            |
  +--------------------------------------------------+

-----------------
Attribute Details
-----------------

.. _active:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
active : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns or sets the object activeness.

Setting this on or off sets all children.
Setting to True sets all the parents active too.

.. _arrowScale:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
arrowScale : :ref:`Double <Double (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The scaling factor used to draw the graphical arrow of the actuator.

.. _averageValue:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
averageValue : :ref:`EnumUnion (type) <EnumUnion (type) (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The average value for the actuator when the function is set to
Oscillating, defaults to 0.

.. _baseScale:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
baseScale : :ref:`Double <Double (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The scaling factor used to draw the graphical base body of the actuator.

.. _clevisPinHoles:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
clevisPinHoles : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Lists all the cylindrical features from a clevis pin part, that has 3 aligned holes
and outside two holes are in the same part.

.. _coaxial:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
coaxial : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


If True, the actuator maintains the direction relative to shaftConnection.

This property is only specifiable when lineOfSight is False

.. _coaxialJoint:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
coaxialJoint : :ref:`Enum <Enum (hwx.inspire)>` (CYLINDRICAL, TRANSLATIONAL)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Creates a joint in the direction of actuation.

CoaxialJoint can be a Cylindrical or Translational.
This property is only specifiable when lineOfSight is False

.. _connectionRadius:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
connectionRadius : :ref:`Double <Double (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the radius of the connection.

.. _controller:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
controller : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


If True, sets the behavior of the Actuator specified by function
and value properties, else the behavior of the actuator will be driven
with hand of god type motion

.. _controllerType:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
controllerType : :ref:`Enum <Enum (hwx.inspire)>` (PID, SOFT_CONSTRAINT)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The type of controller used to achieve the behavior specified by
function and value.

Controller type can be PID or Soft Constraint.

Specifiable when actuator is of type Displacement or Velocity and
controller is set to True

.. _direction:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
direction : :ref:`Direction <Direction (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The direction of the actuator wrt shaftConnection.

.. _dtValue:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
dtValue : :ref:`Double <Double (hwx.inspire)>` (units="time")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the amount of time allowed to blend in and out of the
actuation profile.

Specifiable when function is set to Single Wave, Oscillating and Table,
defaults to 0.05s.

.. _duration:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
duration : :ref:`Double <Double (hwx.inspire)>` (units="time")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The amount of time the function will take for Step and Impulse.

For Ramp function duration is defined as the amount of time taken by the
actuator to achieve the value.

.. _dwellTime:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
dwellTime : :ref:`Double <Double (hwx.inspire)>` (units="time")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The amount time of the actuation profile dwells.

Specifiable when function is set to Step Dwell Step, defaults to 1s.

.. _entity1:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
entity1 : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The feature entity actuator is attached to.

.. _entity2:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
entity2 : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The second feature entity actuator is attached to.

.. _finalFrequency:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
finalFrequency : :ref:`Double <Double (hwx.inspire)>` (units="frequency")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The final frequency for the actuator function Swept Sine, defaults to 1Hz.

.. _flipAxis:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
flipAxis : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


If True, flips the axis direction of the actuator, defaults to False.

.. _frequency:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
frequency : :ref:`Double <Double (hwx.inspire)>` (units="frequency")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the frequency value in Hz, when the function is set to
Oscillating, defaults to 1Hz.

.. _function:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
function : :ref:`Enum <Enum (hwx.inspire)>` (STEP, SDS, SINE, SHF, SWEPT_SINE, IMPULSE, RAMP, USER, SPLINE)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The type of actuation profile.

The function can be a Step, Step Dwell Step, Single Wave, Oscillating,
Swept Sine, Impulse, Ramp, Solver Expression and Table, defaults to Step Dwell Step

.. _icVelocity:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
icVelocity : :ref:`Double <Double (hwx.inspire)>` (units="velocity")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The initial velocity of the
actuator.

This is specifiable when the type of actuator is Acceleration

.. _initialFrequency:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
initialFrequency : :ref:`Double <Double (hwx.inspire)>` (units="frequency")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The initial frequency for the actuator function Swept Sine, defaults to 1Hz.

.. _joint:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
joint : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _kd:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
kd : :ref:`Double <Double (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The derivative
action of a PID controller enhances stability of the control system by
predicting the future behavior.

.. _ki:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ki : :ref:`Double <Double (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


This term
multiplied by accumulated error represents the integral term of a PID.
Having an integral term minimizes the steady state error.

.. _kp:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
kp : :ref:`Double <Double (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The amount of
restoring force that should be applied to overcome position error.

Specifiable only when controller type is set to PID.

.. _lineOfSight:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lineOfSight : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


If True, the direction of the actuation is defined by both shaft and
mount location attributes, defaults to False

.. _location1:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
location1 : :ref:`Location <Location (hwx.inspire)>` (units="length")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The location of the actuator wrt shaftConnection.

.. _location2:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
location2 : :ref:`Location <Location (hwx.inspire)>` (units="length")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The location of the actuator wrt mountConnection.

This is specifiable when lineOfSight is True.

.. _locked:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
locked : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


If True, the actuator does not actuate during a Motion Analysis,
defaults to False.

.. _mountColor:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
mountColor : :ref:`Color <Color (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The color for the base body of the actuator.

.. _mountPivotAxis:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
mountPivotAxis : :ref:`Direction <Direction (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the direction of the actuator mount pivot.

This property is only specifiable when mountPivotType is set to Revolute.

.. _mountPivotType:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
mountPivotType : :ref:`Enum <Enum (hwx.inspire)>` (FIXED, SPHERICAL, REVOLUTE)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies how the mount connection attaches to the actuator.

The type can be, Fixed, Spherical or Revolute. This property is only specifiable
when lineOfSight is True

.. _name:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
name : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns or sets the name of the object.

It can be any text string, including spaces, although it's best to avoid
using the following characters: " ' * ? and $.

While these characters are allowed, they could create difficulties when
you export the model to other applications.

.. _parts:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
parts : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Lists all the parts the object is attached to.

.. _penalty:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
penalty : :ref:`Double <Double (hwx.inspire)>` (units="stiffness")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The proportional factor used in the calculation of the restoring
force.

Specifiable only when controller type is set to Soft Constraint.

.. _penalty1:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
penalty1 : :ref:`Double <Double (hwx.inspire)>` (units="damping")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The derivative factor used in the calculation of the restoring
force.

Specifiable only when controller type is set to Soft Constraint.

.. _phaseShift:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
phaseShift : :ref:`Double <Double (hwx.inspire)>` (units="angle")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The angular phase shift of the actuator when the function is set to
Oscillating, defaults to 0 deg.

.. _profile:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
profile : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _reverseDirection:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
reverseDirection : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


If True, reverses the direction of the applied force, defaults to
False.

.. _rotateWithPart:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
rotateWithPart : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The actuator rotates with the attached part during a Motion Analysis,
defaults to True.

.. _rotation:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
rotation : :ref:`Double <Double (hwx.inspire)>` (units="angle")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The rotational offset of the actuator base.

.. _shaftColor:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
shaftColor : :ref:`Color <Color (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The color for the cylindrical shaft of the actuator.

.. _shaftRadius:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
shaftRadius : :ref:`Double <Double (hwx.inspire)>` (units="length")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The radius value for the cylindrical shaft of the actuator.

.. _shaftRotation:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
shaftRotation : :ref:`Double <Double (hwx.inspire)>` (units="angle")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The rotational offset of the actuator shaft.

.. _span:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
span : :ref:`Double <Double (hwx.inspire)>` (units="time")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the duration of the oscillation, when the function is set to
Oscillating or Single Wave, defaults to 2s.

.. _spline:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spline : :ref:`EnumUnion (type) <EnumUnion (type) (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _splineMethod:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
splineMethod : :ref:`Enum <Enum (hwx.inspire)>` (AKIMA, CUBIC, LINEAR)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the interpolation method for the actuation profile.

Interploation methods can be Akima, Cubic, Linear. Specifiable when
function is set to Table

.. _startTime:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
startTime : :ref:`Double <Double (hwx.inspire)>` (units="time")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The time at which the actuator begins to move during a Motion Analysis.

This is not specifiable when actuator function is of type Solver Expression

.. _stepOff:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
stepOff : :ref:`Double <Double (hwx.inspire)>` (units="time")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The amount of time taken to ramp down the Step Dwell Step function,
defaults to 0.5s.

.. _stepOn:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
stepOn : :ref:`Double <Double (hwx.inspire)>` (units="time")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The amount of time taken to ramp up the Step Dwell Step function,
defaults to 0.5s.

.. _sweepInterval:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
sweepInterval : :ref:`Double <Double (hwx.inspire)>` (units="time")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The amount of time that should be spent transitioning between the
initialFrequency and finalFrequency of a Swept Sine function, defaults to 1s.

.. _type:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
type : :ref:`Enum <Enum (hwx.inspire)>` (DISPLACEMENT, SPEED, ACCELERATION, FORCE)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Type of Actuation to be performed.

Type can be Displacement, Velocity, Acceleration and Force.

.. _userFunction:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
userFunction : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


A
motionsolve user expression that will define the behavior of the actuation.

Specifiable when function is set to Solver Expression, defaults to TIME

.. _userFunctionScale:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
userFunctionScale : :ref:`Double <Double (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The
scaling factor for the user expression.

Specifiable when function is set to Solver Expression.

.. _userFunctionUnits:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
userFunctionUnits : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The units for the user expression.

Specifiable when function is set to Solver Expression.

.. _value:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
value : :ref:`EnumUnion (type) <EnumUnion (type) (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the absolute translational
value of the actuator depending upon the type.
If type of actuator is:
  - Displacement then the default value is 100 mm.
  - Velocity then the default value is 1 m/s.
  - Acceleration then the default value is 1 m/s2.
  - Force the the default value is 1 N.

.. _visible:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
visible : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Determines whether the object is visible in the modeling window.

Setting this on or off sets all children.
Setting to True sets all the parents visible too.

.. _writePlantSignals:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
writePlantSignals : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Generates a plant input and output signal for the actuator, if set to True


----------------
Property Details
----------------

.. _baseRotation:
.. method:: baseRotation

The rotational offset of the actuator base.

.. _connectorMode:
.. method:: connectorMode

Specifies the type of connection used by the actuator.

connectorModes can be,

    - 'PointToPoint' if lineOfSight is enabled, otherwise
    - 'Face'

.. _mountConnection:
.. method:: mountConnection

The second feature entity actuator is attached to.

.. _mountLocation:
.. method:: mountLocation

The location of the actuator wrt mountConnection. 

This is specifiable when lineOfSight is True.

.. _shaftConnection:
.. method:: shaftConnection

The feature entity actuator is attached to.

.. _shaftDirection:
.. method:: shaftDirection

The direction of the actuator wrt shaftConnection.

.. _shaftLocation:
.. method:: shaftLocation

The location of the actuator wrt shaftConnection.

--------------
Method Details
--------------

.. _areFeaturesASlot:
.. classmethod:: areFeaturesASlot(cls, obj, planes)

Filters out contact-joints that are slots.

:param obj: Joint object used to get the axis points.
:type obj: Joint
:param planes: Plane features from which slots are determined.
:type planes: FeaturePlanar

:returns: True if the planes are slots, False otherwise.
:rtype: bool


.. _isValidCandidate:
.. classmethod:: isValidCandidate(cls, obj)

Determines if an actuator can be created from the passed joint connection.

:param obj: A joint object.
:type obj: Joint

:returns: A valid joint candidate.
:rtype: bool


.. _getShaftLength:
.. method:: getShaftLength(self)

Computes the shaft length for non LOS and non 2 holes cases.

.. _getShaftRadius:
.. method:: getShaftRadius(self)

Returns the shafts hole radius or the radius attribute.

.. _getTranslationalValue:
.. method:: getTranslationalValue(self)

Return the speed, displacement or acceleration depending on the
classification of the actuator.

.. _isCoaxial:
.. method:: isCoaxial(self)

Determines if the actuator axis restrained by a CYLINDRICAL joint.

.. _isLineOfSight:
.. method:: isLineOfSight(self)

Determines if this is a line of sight actuator.