===========================
LoadCase (hwx.inspire.core)
===========================

A collection of BoundaryConditions/Grounded PartsConnectors (Fastener, Joint).

The same BoundaryConditions/Grounded PartsConnectors can appear in
multiple LoadCases, while duplicates are not allowed.

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

  +------------------+------------------+------------------+
  | active_: Bool    | name_: Attribute | visible_: Bool   |
  +------------------+------------------+------------------+

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

  +--------+
  | loads_ |
  +--------+

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

  +-----------------------+
  | add_ (self, items)    |
  +-----------------------+
  | remove_ (self, items) |
  +-----------------------+

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

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

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


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

.. _loads:
.. method:: loads

The list of BoundaryConditions/Grounded PartsConnectors of this loadcase.

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

.. _add:
.. method:: add(self, items)

Adds one or more BoundaryConditions/Grounded PartsConnectors to this load case.

:param items: List of entities to add to loadcase.
:type items: Union[Union[BoundaryCondition, PartsConnector], list[Union[BoundaryCondition, PartsConnector]]]

:returns: Returns True, if added to load case, else False.
:rtype: bool


.. _remove:
.. method:: remove(self, items)

Removes one or more BoundaryConditions/Grounded PartsConnectors to this load case.

:param items: List of entities to add to loadcase.
:type items: Union[Union[BoundaryCondition, PartsConnector], list[Union[BoundaryCondition, PartsConnector]]]

:returns: Returns True, if removed from load case, else False.
:rtype: bool