.. vale off :class:`Path` ============= .. py:class:: ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Path Bases: :py:obj:`object` Defines a Path. .. !! processed by numpydoc !! .. py:currentmodule:: Path Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~FlipPathOrientatation` - Flip Path Orientatation * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. * - :py:attr:`~SnapPathToMeshNodes` - Snap path to mesh nodes .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~DiscretizationPoints` - Gets or sets the DiscretizationPoints. * - :py:attr:`~EndCoordinateSystem` - Gets or sets the EndCoordinateSystem. * - :py:attr:`~EndXCoordinate` - Gets or sets the EndXCoordinate. * - :py:attr:`~EndYCoordinate` - Gets or sets the EndYCoordinate. * - :py:attr:`~EndZCoordinate` - Gets or sets the EndZCoordinate. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~HasValidGeometrySelection` - Gets the HasValidGeometrySelection. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Location` - Gets or sets the Location. * - :py:attr:`~NumberOfSamplingPoints` - Gets or sets the NumberOfSamplingPoints. * - :py:attr:`~NumberOfSubpaths` - Gets or sets the NumberOfSubpaths. * - :py:attr:`~OffsetEdgeLocation` - Gets or sets the OffsetEdgeLocation. * - :py:attr:`~PathCoordinateSystem` - Gets or sets the PathCoordinateSystem. * - :py:attr:`~PathType` - Gets or sets the PathType. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~ShowMesh` - Gets or sets the ShowMesh. * - :py:attr:`~SnapToMeshNodes` - Gets or sets the SnapToMeshNodes. * - :py:attr:`~StartCoordinateSystem` - Gets or sets the StartCoordinateSystem. * - :py:attr:`~StartXCoordinate` - Gets or sets the StartXCoordinate. * - :py:attr:`~StartYCoordinate` - Gets or sets the StartYCoordinate. * - :py:attr:`~StartZCoordinate` - Gets or sets the StartZCoordinate. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: DiscretizationPoints :type: Optional[int] Gets or sets the DiscretizationPoints. .. !! processed by numpydoc !! .. py:property:: EndCoordinateSystem :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the EndCoordinateSystem. .. !! processed by numpydoc !! .. py:property:: EndXCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the EndXCoordinate. .. !! processed by numpydoc !! .. py:property:: EndYCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the EndYCoordinate. .. !! processed by numpydoc !! .. py:property:: EndZCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the EndZCoordinate. .. !! processed by numpydoc !! .. py:property:: Figures :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: HasValidGeometrySelection :type: Optional[bool] Gets the HasValidGeometrySelection. .. !! processed by numpydoc !! .. py:property:: Images :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSPathAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Location :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! processed by numpydoc !! .. py:property:: NumberOfSamplingPoints :type: Optional[int] Gets or sets the NumberOfSamplingPoints. .. !! processed by numpydoc !! .. py:property:: NumberOfSubpaths :type: Optional[int] Gets or sets the NumberOfSubpaths. .. !! processed by numpydoc !! .. py:property:: OffsetEdgeLocation :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the OffsetEdgeLocation. .. !! processed by numpydoc !! .. py:property:: PathCoordinateSystem :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the PathCoordinateSystem. .. !! processed by numpydoc !! .. py:property:: PathType :type: Optional[Ansys.Mechanical.DataModel.Enums.PathScopingType] Gets or sets the PathType. .. !! processed by numpydoc !! .. py:property:: Properties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: ShowMesh :type: Optional[bool] Gets or sets the ShowMesh. .. !! processed by numpydoc !! .. py:property:: SnapToMeshNodes :type: Optional[bool] Gets or sets the SnapToMeshNodes. .. !! processed by numpydoc !! .. py:property:: StartCoordinateSystem :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the StartCoordinateSystem. .. !! processed by numpydoc !! .. py:property:: StartXCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the StartXCoordinate. .. !! processed by numpydoc !! .. py:property:: StartYCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the StartYCoordinate. .. !! processed by numpydoc !! .. py:property:: StartZCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the StartZCoordinate. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[bool] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: str) -> Ansys.ACT.Automation.Mechanical.Image .. code-block:: text Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the image will be a screen capture of the Geometry window. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> None Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: Delete() -> None Run the Delete action. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: FlipPathOrientatation() -> None Flip Path Orientatation .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: bool, children: List[ChildrenType]) -> List[ChildrenType] Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> None Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: str) -> Ansys.ACT.Automation.Mechanical.Property .. code-block:: text Get a property by its API name. If multiple properties have the same API Name, only the first property with that name will be returned. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: SnapPathToMeshNodes() -> None Snap path to mesh nodes .. !! processed by numpydoc !! .. vale on