Symmetry#

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

Bases: object

Defines a Symmetry.

Overview#

Activate

Activate the current object.

AddComment

Creates a new child Comment.

AddCyclicRegion

Creates a new CyclicRegion

AddFigure

Creates a new child Figure.

AddGeneralAxisymmetric

Creates a new GeneralAxisymmetric

AddImage

Creates a new child Image.

AddLinearPeriodicRegion

Creates a new SymmetryRegion

AddPeriodicRegion

Creates a new PeriodicRegion

AddPreMeshedCyclicRegion

Creates a new PreMeshedCyclicRegion

AddStage

Creates a new Stage

AddSymmetryRegion

Creates a new SymmetryRegion

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.

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.

ToString

ToString method.

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.

Figures

Gets the list of associated figures.

GroupingFolder

GroupingFolder property.

IconName

IconName property.

Images

Gets the list of associated images.

ImportableObjectSourceId

ImportableObjectSourceId property.

InternalObject

Gets the internal object. For advanced usage only.

Name

Name property.

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.

SendPremeshedBoundaries

Gets or sets the SendPremeshedBoundaries.

State

State property.

TransferableObjectId

TransferableObjectId property.

VisibleProperties

Gets the list of properties that are visible for this object.

Property detail#

property Symmetry.AttachedRefs: List[int] | None#

AttachedRefs property.

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

Gets the list of children.

property Symmetry.ClsId: int | None#

ClsId property.

property Symmetry.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#

Gets the list of associated comments.

property Symmetry.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property Symmetry.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

GroupingFolder property.

property Symmetry.IconName: str | None#

IconName property.

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

Gets the list of associated images.

property Symmetry.ImportableObjectSourceId: str | None#

ImportableObjectSourceId property.

property Symmetry.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSSymmetryGroupAuto | None#

Gets the internal object. For advanced usage only.

property Symmetry.Name: str | None#

Name property.

property Symmetry.ObjectId: int | None#

ObjectId property.

property Symmetry.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#

ObjectState property.

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

ObjectTags property.

property Symmetry.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

Parent property.

property Symmetry.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties for this object.

property Symmetry.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property Symmetry.SendPremeshedBoundaries: bool | None#

Gets or sets the SendPremeshedBoundaries.

property Symmetry.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#

State property.

property Symmetry.TransferableObjectId: str | None#

TransferableObjectId property.

property Symmetry.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties that are visible for this object.

Method detail#

Symmetry.Activate() None#

Activate the current object.

Symmetry.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

Symmetry.AddCyclicRegion() Ansys.ACT.Automation.Mechanical.CyclicRegion#

Creates a new CyclicRegion

Symmetry.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

Symmetry.AddGeneralAxisymmetric() Ansys.ACT.Automation.Mechanical.GeneralAxisymmetric#

Creates a new GeneralAxisymmetric

Symmetry.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.
Symmetry.AddLinearPeriodicRegion() Ansys.ACT.Automation.Mechanical.SymmetryRegion#

Creates a new SymmetryRegion

Symmetry.AddPeriodicRegion() Ansys.ACT.Automation.Mechanical.PeriodicRegion#

Creates a new PeriodicRegion

Symmetry.AddPreMeshedCyclicRegion() Ansys.ACT.Automation.Mechanical.PreMeshedCyclicRegion#

Creates a new PreMeshedCyclicRegion

Symmetry.AddStage() Ansys.ACT.Automation.Mechanical.Stage#

Creates a new Stage

Symmetry.AddSymmetryRegion() Ansys.ACT.Automation.Mechanical.SymmetryRegion#

Creates a new SymmetryRegion

Symmetry.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

Symmetry.CreateObjRef(requestedType: type) System.Runtime.Remoting.ObjRef#

CreateObjRef method.

Symmetry.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

Symmetry.Delete() None#

Run the Delete action.

Symmetry.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

Symmetry.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) bool#

Equals method.

Symmetry.GetAPIName(dispId: int) str#

Property name bound to dispId.

Symmetry.GetAllProperties() List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#

GetAllProperties method.

Symmetry.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

Symmetry.GetDetailsView() Ansys.ACT.Automation.Mechanical.DetailsViewData#

GetDetailsView method.

Symmetry.GetEnumName(enumType: type, value: int, dispId: int) str#

Enum name bound to value

Symmetry.GetHashCode() int#

GetHashCode method.

Symmetry.GetIconFile() System.Byte#

GetIconFile method.

Symmetry.GetLifetimeService() Any#

GetLifetimeService method.

Symmetry.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) None#

GetObjectData method.

Symmetry.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

Symmetry.GetPath() str#

GetPath method.

Symmetry.GetPropertyName(dispId: int) str#

GetPropertyName method.

Symmetry.GetPropertyValue(name: str) Any#

GetPropertyValue method.

Symmetry.GetType() type#

GetType method.

Symmetry.GetVisibleProperties() List[System.Reflection.PropertyInfo]#

GetVisibleProperties method.

Symmetry.GetVisiblePropertyNames() List[str]#

GetVisiblePropertyNames method.

Symmetry.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

Symmetry.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

Symmetry.InitializeLifetimeService() Any#

InitializeLifetimeService method.

Symmetry.IsPropertyEditable(dispId: int) bool#

IsPropertyEditable method.

Symmetry.IsPropertyVisible(dispId: int) bool#

IsPropertyVisible method.

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

PropertyById method.

Symmetry.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

Symmetry.RemoveParameter(propName: str) None#

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

Symmetry.ToString() str#

ToString method.