.. vale off



:class:`ConstructionLineHelper`
===============================

.. py:class:: ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.ConstructionLines.ConstructionLineHelper

   Bases: :py:obj:`object`


   
   Helper to perform queries and modifications against a ConstructionLine instance.
















   ..
       !! processed by numpydoc !!










.. py:currentmodule:: ConstructionLineHelper

Overview
--------

.. tab-set::


   .. tab-item:: Constructors

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~GetEdgeVerticesById`
            - GetEdgeVerticesById method.
          * - :py:attr:`~GetEdgesById`
            - GetEdgesById method.
          * - :py:attr:`~GetPlanesById`
            - GetPlanesById method.
          * - :py:attr:`~GetEdgesUsingPoint`
            - Get a list of IEdge that use the given Point.
          * - :py:attr:`~GetContainedEdges`
            - Get all the edges that have both start and end edge vertices in the given plane.
          * - :py:attr:`~GetRelatedEdges`
            - Get all the edges that have only edge vertex in the given plane.
          * - :py:attr:`~ExportToXML`
            - Collect all the edges and edge vertices, then export them as global points to an XML file.
          * - :py:attr:`~ClearExistingDataAndImportFromXML`
            - Import global points and connecting edges from an XML file.













Method detail
-------------
.. py:method:: GetEdgeVerticesById(constructionLine: Ansys.ACT.Automation.Mechanical.ConstructionLines.ConstructionLine, edgeVertexIdCollection: System.Collections.Generic.IEnumerable[System.Int32]) -> System.Collections.Generic.IList[System.Object]
   :classmethod:

   :no-index:

   GetEdgeVerticesById method.

   ..
       !! processed by numpydoc !!

.. py:method:: GetEdgesById(constructionLine: Ansys.ACT.Automation.Mechanical.ConstructionLines.ConstructionLine, edgeIdCollection: System.Collections.Generic.IEnumerable[System.Int32]) -> System.Collections.Generic.IList[System.Object]
   :classmethod:

   :no-index:

   GetEdgesById method.

   ..
       !! processed by numpydoc !!

.. py:method:: GetPlanesById(constructionLine: Ansys.ACT.Automation.Mechanical.ConstructionLines.ConstructionLine, planeIdCollection: System.Collections.Generic.IEnumerable[System.Int32]) -> System.Collections.Generic.IList[System.Object]
   :classmethod:

   :no-index:

   GetPlanesById method.

   ..
       !! processed by numpydoc !!

.. py:method:: GetEdgesUsingPoint(point: Ansys.Mechanical.DataModel.ConstructionLines.Point) -> System.Collections.Generic.IList[System.Object]
   :classmethod:

   :no-index:

   Get a list of IEdge that use the given Point.

   ..
       !! processed by numpydoc !!

.. py:method:: GetContainedEdges(plane: Ansys.Mechanical.DataModel.ConstructionLines.Plane) -> System.Collections.Generic.IList[System.Object]
   :classmethod:

   :no-index:

   Get all the edges that have both start and end edge vertices in the given plane.

   ..
       !! processed by numpydoc !!

.. py:method:: GetRelatedEdges(plane: Ansys.Mechanical.DataModel.ConstructionLines.Plane) -> System.Collections.Generic.IList[System.Object]
   :classmethod:

   :no-index:

   Get all the edges that have only edge vertex in the given plane.

   ..
       !! processed by numpydoc !!

.. py:method:: ExportToXML(constructionLine: Ansys.ACT.Automation.Mechanical.ConstructionLines.ConstructionLine, xmlFilePath: System.String) -> System.Void
   :classmethod:

   :no-index:

   Collect all the edges and edge vertices, then export them as global points to an XML file.

   ..
       !! processed by numpydoc !!

.. py:method:: ClearExistingDataAndImportFromXML(constructionLine: Ansys.ACT.Automation.Mechanical.ConstructionLines.ConstructionLine, xmlFilePath: System.String) -> System.Collections.Generic.IList[System.Object]
   :classmethod:

   :no-index:

   Import global points and connecting edges from an XML file.

   ..
       !! processed by numpydoc !!



.. vale on