AnalysisPly
Last update: 14.01.2025
AnalysisPly
class Ansys.ACT.Automation.Mechanical.AnalysisPly
Bases: object
Defines a AnalysisPly.
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. |
Duplicate |
Creates a copy of the current DataModelObject. |
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. |
Properties
Name | Description |
---|---|
Angle |
Gets or sets the Angle. |
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
Figures |
Gets the list of associated figures. |
IDInSource |
Gets the IDInSource. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
Material |
Gets the Material. |
NameInSource |
Gets the NameInSource. |
NumberOfElements |
Gets the NumberOfElements. |
Properties |
Gets the list of properties for this object. |
ReadOnly |
Gets or sets the ReadOnly. |
Thickness |
Gets the Thickness. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property AnalysisPly.Angle : Ansys.Core.Units.Quantity | None
Gets or sets the Angle.
property AnalysisPly.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property AnalysisPly.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property AnalysisPly.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property AnalysisPly.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property AnalysisPly.IDInSource : str | None
Gets the IDInSource.
property AnalysisPly.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property AnalysisPly.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSAnalysisPlyAuto | None
Gets the internal object. For advanced usage only.
property AnalysisPly.Material : str | None
Gets the Material.
property AnalysisPly.NameInSource : str | None
Gets the NameInSource.
property AnalysisPly.NumberOfElements : int | None
Gets the NumberOfElements.
property AnalysisPly.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property AnalysisPly.ReadOnly : bool | None
Gets or sets the ReadOnly.
property AnalysisPly.Thickness : Ansys.Core.Units.Quantity | None
Gets the Thickness.
property AnalysisPly.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
AnalysisPly.Activate()
Activate the current object.
AnalysisPly.AddComment()
Creates a new child Comment.
AnalysisPly.AddFigure()
Creates a new child Figure.
AnalysisPly.AddImage(filePath: str)
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.
AnalysisPly.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
AnalysisPly.CreateParameter(propName: str)
Creates a new parameter for a Property.
AnalysisPly.Duplicate()
Creates a copy of the current DataModelObject.
AnalysisPly.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
AnalysisPly.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
AnalysisPly.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
AnalysisPly.GroupSimilarObjects()
Run the GroupSimilarObjects action.
AnalysisPly.PropertyByAPIName(name: str)
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.
AnalysisPly.PropertyByName(name: str)
Get a property by its unique name.
AnalysisPly.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.