`Path`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Path#

Bases: object

Defines a Path.

Overview#

Methods

`SnapPathToMeshNodes`	Snap path to mesh nodes
`FlipPathOrientatation`	Flip Path Orientatation
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`DiscretizationPoints`	Gets or sets the DiscretizationPoints.
`InternalObject`	Gets the internal object. For advanced usage only.
`NumberOfSubpaths`	Gets or sets the NumberOfSubpaths.
`NumberOfSamplingPoints`	Gets or sets the NumberOfSamplingPoints.
`EndXCoordinate`	Gets or sets the EndXCoordinate.
`EndYCoordinate`	Gets or sets the EndYCoordinate.
`EndZCoordinate`	Gets or sets the EndZCoordinate.
`StartXCoordinate`	Gets or sets the StartXCoordinate.
`StartYCoordinate`	Gets or sets the StartYCoordinate.
`StartZCoordinate`	Gets or sets the StartZCoordinate.
`PathType`	Gets or sets the PathType.
`HasValidGeometrySelection`	Gets the HasValidGeometrySelection.
`ShowMesh`	Gets or sets the ShowMesh.
`SnapToMeshNodes`	Gets or sets the SnapToMeshNodes.
`Suppressed`	Gets or sets the Suppressed.
`PathCoordinateSystem`	Gets or sets the PathCoordinateSystem.
`EndCoordinateSystem`	Gets or sets the EndCoordinateSystem.
`StartCoordinateSystem`	Gets or sets the StartCoordinateSystem.
`Location`	Gets or sets the Location.
`OffsetEdgeLocation`	Gets or sets the OffsetEdgeLocation.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property Path.DiscretizationPoints: System.Int32 | None: Gets or sets the DiscretizationPoints.

property Path.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSPathAuto | None: Gets the internal object. For advanced usage only.

property Path.NumberOfSubpaths: System.Int32 | None: Gets or sets the NumberOfSubpaths.

property Path.NumberOfSamplingPoints: System.Int32 | None: Gets or sets the NumberOfSamplingPoints.

property Path.EndXCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the EndXCoordinate.

property Path.EndYCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the EndYCoordinate.

property Path.EndZCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the EndZCoordinate.

property Path.StartXCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the StartXCoordinate.

property Path.StartYCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the StartYCoordinate.

property Path.StartZCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the StartZCoordinate.

property Path.PathType: Ansys.Mechanical.DataModel.Enums.PathScopingType | None: Gets or sets the PathType.

property Path.HasValidGeometrySelection: System.Boolean | None: Gets the HasValidGeometrySelection.

property Path.ShowMesh: System.Boolean | None: Gets or sets the ShowMesh.

property Path.SnapToMeshNodes: System.Boolean | None: Gets or sets the SnapToMeshNodes.

property Path.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property Path.PathCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the PathCoordinateSystem.

property Path.EndCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the EndCoordinateSystem.

property Path.StartCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the StartCoordinateSystem.

property Path.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property Path.OffsetEdgeLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the OffsetEdgeLocation.

property Path.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property Path.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property Path.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property Path.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property Path.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property Path.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property Path.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property Path.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

Path.SnapPathToMeshNodes() → System.Void: Snap path to mesh nodes

Path.FlipPathOrientatation() → System.Void: Flip Path Orientatation

Path.Delete() → System.Void: Run the Delete action.

Path.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

Path.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

Path.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

Path.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

Path.AddImage(filePath: System.String) → Ansys.ACT.Automation.Mechanical.Image

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.

Path.Activate() → System.Void: Activate the current object.

Path.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

Path.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

Path.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

Path.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

Path.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

Path.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

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.

Path.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

Path.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

Path.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.