========================
Holes (hwx.inspire.core)
========================

Holes found in the model. The items in the list are HoleData.

Has members:

- aligned  - List of aligned holes.
- singular - List of single holes.
- minsize  - The calculated smallest hole size in the model.
- maxsize  - The calculated largest  hole size in the model.

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

  +----------------------------------------------------------------------------------------+
  | getHoleFromFeature_ (self, feature, holeList=True)                                     |
  +----------------------------------------------------------------------------------------+
  | getUnfilteredHoleFromFeature_ (self, feature)                                          |
  +----------------------------------------------------------------------------------------+
  | getUnfilteredSingleHoleFromFeature_ (self, feature)                                    |
  +----------------------------------------------------------------------------------------+
  | makeDirty_ (self)                                                                      |
  +----------------------------------------------------------------------------------------+
  | populate_ (self, minsize=None, maxsize=None, parts=None, holeType=None, cadParts=None) |
  +----------------------------------------------------------------------------------------+

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

.. _getHoleFromFeature:
.. method:: getHoleFromFeature(self, feature, holeList=True)

Returns the holes found from the specified feature.

:param feature: Part feature on which holes need to be found.
:type feature: Feature
:param holeList: If True, returns the holes as a list.
:type holeList: bool

:returns: Holes found from the feature.
:rtype: Holes


.. _getUnfilteredHoleFromFeature:
.. method:: getUnfilteredHoleFromFeature(self, feature)

Returns aligned hole from specified feature.

:param feature: Part feature on which aligned hole need to be found.
:type feature: Feature

:returns: Aligned Hole found from the feature.
:rtype: AlignedHole


.. _getUnfilteredSingleHoleFromFeature:
.. method:: getUnfilteredSingleHoleFromFeature(self, feature)

Returns the single hole found from specified feature.

:param feature: Part feature on which single hole need to be found.
:type feature: Feature

:returns: Single Hole found from the feature.
:rtype: Hole


.. _makeDirty:
.. method:: makeDirty(self)

Repopulates the holes.


.. _populate:
.. method:: populate(self, minsize=None, maxsize=None, parts=None, holeType=None, cadParts=None)

Finds all the holes that satisfies the given condition.

:param minsize: Get the holes with a size larger than minsize.
:type minsize: float
:param maxsize: Get the holes with a size smaller than maxsize.
:type maxsize: float
:param parts: Get the holes for these parts.
:type parts: Part,list[Part]
:param holeType: Filters the hole based on type.  Allowed types are 'through', 'blind' and 'all'.
:type holeType: str
:param cadParts: If true, finds existing geometry in holes.
:type cadParts: bool