`Path`
Last update: 16.07.2025class Ansys.ACT.Automation.Mechanical.Path
Bases: object
Defines a Path.
Overview
Methods
| Name | Description |
|---|---|
Activate |
Activate the current object. |
AddComment |
Creates a new child Comment. |
AddFigure |
Creates a new child Figure. |
AddImage |
Creates a new child Image. |
CopyTo |
Copies all visible properties from this object to another. |
CreateParameter |
Creates a new parameter for a Property. |
Delete |
Run the Delete action. |
Duplicate |
Creates a copy of the current DataModelObject. |
FlipPathOrientatation |
Flip Path Orientatation |
GetChildren |
Gets the list of children, filtered by type. |
GetParameter |
Gets the parameter corresponding to the given property. |
GroupAllSimilarChildren |
Run the GroupAllSimilarChildren action. |
GroupSimilarObjects |
Run the GroupSimilarObjects action. |
PropertyByAPIName |
Get a property by its API name. |
PropertyByName |
Get a property by its unique name. |
RemoveParameter |
Removes the parameter from the parameter set corresponding to the given property. |
SnapPathToMeshNodes |
Snap path to mesh nodes |
Properties
| Name | Description |
|---|---|
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
DiscretizationPoints |
Gets or sets the DiscretizationPoints. |
EndCoordinateSystem |
Gets or sets the EndCoordinateSystem. |
EndXCoordinate |
Gets or sets the EndXCoordinate. |
EndYCoordinate |
Gets or sets the EndYCoordinate. |
EndZCoordinate |
Gets or sets the EndZCoordinate. |
Figures |
Gets the list of associated figures. |
HasValidGeometrySelection |
Gets the HasValidGeometrySelection. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
Location |
Gets or sets the Location. |
NumberOfSamplingPoints |
Gets or sets the NumberOfSamplingPoints. |
NumberOfSubpaths |
Gets or sets the NumberOfSubpaths. |
OffsetEdgeLocation |
Gets or sets the OffsetEdgeLocation. |
PathCoordinateSystem |
Gets or sets the PathCoordinateSystem. |
PathType |
Gets or sets the PathType. |
Properties |
Gets the list of properties for this object. |
ShowMesh |
Gets or sets the ShowMesh. |
SnapToMeshNodes |
Gets or sets the SnapToMeshNodes. |
StartCoordinateSystem |
Gets or sets the StartCoordinateSystem. |
StartXCoordinate |
Gets or sets the StartXCoordinate. |
StartYCoordinate |
Gets or sets the StartYCoordinate. |
StartZCoordinate |
Gets or sets the StartZCoordinate. |
Suppressed |
Gets or sets the Suppressed. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property Path.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property Path.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property Path.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property Path.DiscretizationPoints : int | None
Gets or sets the DiscretizationPoints.
property Path.EndCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None
Gets or sets the EndCoordinateSystem.
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.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property Path.HasValidGeometrySelection : bool | None
Gets the HasValidGeometrySelection.
property Path.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property Path.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSPathAuto | None
Gets the internal object. For advanced usage only.
property Path.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
property Path.NumberOfSamplingPoints : int | None
Gets or sets the NumberOfSamplingPoints.
property Path.NumberOfSubpaths : int | None
Gets or sets the NumberOfSubpaths.
property Path.OffsetEdgeLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the OffsetEdgeLocation.
property Path.PathCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None
Gets or sets the PathCoordinateSystem.
property Path.PathType : Ansys.Mechanical.DataModel.Enums.PathScopingType | None
Gets or sets the PathType.
property Path.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property Path.ShowMesh : bool | None
Gets or sets the ShowMesh.
property Path.SnapToMeshNodes : bool | None
Gets or sets the SnapToMeshNodes.
property Path.StartCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None
Gets or sets the StartCoordinateSystem.
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.Suppressed : bool | None
Gets or sets the Suppressed.
property Path.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
Path.Activate() → None
Activate the current object.
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: str) → 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.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None
Copies all visible properties from this object to another.
Path.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter
Creates a new parameter for a Property.
Path.Delete() → None
Run the Delete action.
Path.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject
Creates a copy of the current DataModelObject.
Path.FlipPathOrientatation() → None
Flip Path Orientatation
Path.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]
Gets the list of children, filtered by type.
Path.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter
Gets the parameter corresponding to the given property.
Path.GroupAllSimilarChildren() → None
Run the GroupAllSimilarChildren action.
Path.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder
Run the GroupSimilarObjects action.
Path.PropertyByAPIName(name: str) → 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.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property
Get a property by its unique name.
Path.RemoveParameter(propName: str) → None
Removes the parameter from the parameter set corresponding to the given property.
Path.SnapPathToMeshNodes() → None
Snap path to mesh nodes
