Path

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Path(internalObject: Any)

Bases: object

Defines a Path.

Overview

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
ExportToTextFile	Export the Path details to a text file.
FlipPathOrientatation	Flip Path Orientatation
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
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
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
HasValidGeometrySelection	Gets the HasValidGeometrySelection.
IconName	IconName property.
Id	Id property.
Ids	Ids property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
Name	Name property.
NumberOfSamplingPoints	Gets or sets the NumberOfSamplingPoints.
NumberOfSubpaths	Gets or sets the NumberOfSubpaths.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OffsetEdgeLocation	Gets or sets the OffsetEdgeLocation.
Parent	Parent property.
PathCoordinateSystem	Gets or sets the PathCoordinateSystem.
PathType	Gets or sets the PathType.
Properties	Gets the list of properties for this object.
SelectionType	SelectionType property.
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.
State	State property.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property Path.AttachedRefs: List[int] | None

AttachedRefs property.

property Path.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Path.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property Path.HasValidGeometrySelection: bool | None

Gets the HasValidGeometrySelection.

property Path.IconName: str | None

IconName property.

property Path.Id: int | None

Id property.

property Path.Ids: List[int] | None

Ids property.

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.Name: str | None

Name property.

property Path.NumberOfSamplingPoints: int | None

Gets or sets the NumberOfSamplingPoints.

property Path.NumberOfSubpaths: int | None

Gets or sets the NumberOfSubpaths.

property Path.ObjectId: int | None

ObjectId property.

property Path.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property Path.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property Path.OffsetEdgeLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the OffsetEdgeLocation.

property Path.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.SelectionType: Ansys.ACT.Interfaces.Common.SelectionTypeEnum | None

SelectionType property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

Path.ExportToTextFile(filePath: str) → None

Export the Path details to a text file.

Path.FlipPathOrientatation() → None

Flip Path Orientatation

Path.GetAPIName(dispId: int) → str

Property name bound to dispId.

Path.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

Path.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

Path.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

Path.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

Path.GetHashCode() → int

GetHashCode method.

Path.GetIconFile() → System.Byte

GetIconFile method.

Path.GetLifetimeService() → Any

GetLifetimeService method.

Path.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

Path.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Path.GetPath() → str

GetPath method.

Path.GetPropertyName(dispId: int) → str

GetPropertyName method.

Path.GetPropertyValue(name: str) → Any

GetPropertyValue method.

Path.GetType() → type

GetType method.

Path.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

Path.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

Path.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

Path.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

Path.InitializeLifetimeService() → Any

InitializeLifetimeService method.

Path.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

Path.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Path.ToString() → str

ToString method.