Path
#
- class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Path#
Bases:
object
Defines a Path.
Overview#
Activate the current object. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Copies all visible properties from this object to another. |
|
Creates a new parameter for a Property. |
|
Run the Delete action. |
|
Creates a copy of the current DataModelObject. |
|
Flip Path Orientatation |
|
Gets the list of children, filtered by type. |
|
Gets the parameter corresponding to the given property. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its API name. |
|
Get a property by its unique name. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Snap path to mesh nodes |
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets the current DataModelObject's category. |
|
Gets or sets the DiscretizationPoints. |
|
Gets or sets the EndCoordinateSystem. |
|
Gets or sets the EndXCoordinate. |
|
Gets or sets the EndYCoordinate. |
|
Gets or sets the EndZCoordinate. |
|
Gets the list of associated figures. |
|
Gets the HasValidGeometrySelection. |
|
Gets the list of associated images. |
|
Gets the internal object. For advanced usage only. |
|
Gets or sets the Location. |
|
Gets or sets the NumberOfSamplingPoints. |
|
Gets or sets the NumberOfSubpaths. |
|
Gets or sets the OffsetEdgeLocation. |
|
Gets or sets the PathCoordinateSystem. |
|
Gets or sets the PathType. |
|
Gets the list of properties for this object. |
|
Gets or sets the ShowMesh. |
|
Gets or sets the SnapToMeshNodes. |
|
Gets or sets the StartCoordinateSystem. |
|
Gets or sets the StartXCoordinate. |
|
Gets or sets the StartYCoordinate. |
|
Gets or sets the StartZCoordinate. |
|
Gets or sets the Suppressed. |
|
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.EndCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#
Gets or sets the EndCoordinateSystem.
- property Path.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#
Gets the list of associated figures.
- 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.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.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.
Method detail#
- 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.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject #
Creates a copy of the current DataModelObject.
- 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.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder #
Run the GroupSimilarObjects action.
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.