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

A collection of BoundaryConditions.

The same BoundaryCondition can appear in multiple LoadCases.

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

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

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

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

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

  +------------------------+
  | addBC_ (self, bc)      |
  +------------------------+
  | addBCs_ (self, bcs)    |
  +------------------------+
  | containsBC_ (self, bc) |
  +------------------------+
  | removeBC_ (self, bc)   |
  +------------------------+
  | removeBCs_ (self, bcs) |
  +------------------------+

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

Get the loads added to this load case.
It may contain loads (forces, torques etc), supports (Constraint),
displacements, grounded joints / fasteners.

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

.. _addBC:
.. method:: addBC(self, bc)

Adds the bc to this load case.

:param bc: Boundary condition to add to loadcase.
:type bc: BoundaryCondition

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


.. _addBCs:
.. method:: addBCs(self, bcs)

Adds the multiple bcs to this load case.

:param bc: List of boundary conditions to add to loadcase.
:type bc: list[BoundaryCondition]

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


.. _containsBC:
.. method:: containsBC(self, bc)

Returns True if this load case contain the Boundary Condition 'bc',
False otherwise.

:param bc: Boundary condition to check for existence.
:type bc: BoundaryCondition

:returns: Returns True, if bc contains in load case, else False.
:rtype: bool


.. _removeBC:
.. method:: removeBC(self, bc)

Removes bc from this load case.

:param bc: Boundary condition to remove from loadcase.
:type bc: BoundaryCondition

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


.. _removeBCs:
.. method:: removeBCs(self, bcs)

Removes multiple bcs from this load case.

:param bc: List of boundary conditions to remove from loadcase.
:type bc: list[BoundaryCondition]

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