`Symmetry`

class Ansys.ACT.Automation.Mechanical.Symmetry

Bases: object

Defines a Symmetry.

Overview

Methods

Name	Description
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.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
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
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.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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.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.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.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

Symmetry.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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