AnalysisPly

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

Bases: object

Defines a AnalysisPly.

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.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetElementId	GetElementId method.
GetElementLayerNumber	GetElementLayerNumber 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.
ToString	ToString method.

Properties

Angle	Gets or sets the Angle.
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.
ElementCount	ElementCount property.
Figures	Gets the list of associated figures.
GroupingFolder	GroupingFolder property.
IDInSource	Gets the IDInSource.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
Material	Gets the Material.
Name	Name property.
NameInSource	Gets the NameInSource.
NumberOfElements	Gets the NumberOfElements.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
State	State property.
Thickness	Gets the Thickness.
TransferableObjectId	TransferableObjectId property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property AnalysisPly.ClsId: int | None

ClsId property.

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.ElementCount: int | None

ElementCount property.

property AnalysisPly.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property AnalysisPly.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property AnalysisPly.IDInSource: str | None

Gets the IDInSource.

property AnalysisPly.IconName: str | None

IconName property.

property AnalysisPly.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property AnalysisPly.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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

Name property.

property AnalysisPly.NameInSource: str | None

Gets the NameInSource.

property AnalysisPly.NumberOfElements: int | None

Gets the NumberOfElements.

property AnalysisPly.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

State property.

property AnalysisPly.Thickness: Ansys.Core.Units.Quantity | None

Gets the Thickness.

property AnalysisPly.TransferableObjectId: str | None

TransferableObjectId property.

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() → None

Activate the current object.

AnalysisPly.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

AnalysisPly.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

AnalysisPly.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.

AnalysisPly.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

AnalysisPly.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

AnalysisPly.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

AnalysisPly.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

AnalysisPly.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

AnalysisPly.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

AnalysisPly.GetElementId(index: int) → int

GetElementId method.

AnalysisPly.GetElementLayerNumber(index: int) → int

GetElementLayerNumber method.

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

Enum name bound to value

AnalysisPly.GetHashCode() → int

GetHashCode method.

AnalysisPly.GetIconFile() → System.Byte

GetIconFile method.

AnalysisPly.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

AnalysisPly.GetPath() → str

GetPath method.

AnalysisPly.GetPropertyName(dispId: int) → str

GetPropertyName method.

AnalysisPly.GetPropertyValue(name: str) → Any

GetPropertyValue method.

AnalysisPly.GetType() → type

GetType method.

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

GetVisibleProperties method.

AnalysisPly.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

AnalysisPly.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

AnalysisPly.InitializeLifetimeService() → Any

InitializeLifetimeService method.

AnalysisPly.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

AnalysisPly.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

AnalysisPly.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.

AnalysisPly.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

AnalysisPly.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

AnalysisPly.RemoveParameter(propName: str) → None

Removes the parameter from the parameter set corresponding to the given property.

AnalysisPly.ToString() → str

ToString method.