Skip to main content

Mechanical scripting interface

SymmetryRegion

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.SymmetryRegion

Bases: object

Defines a SymmetryRegion.

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.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
FlipHighLow Flips the High and Low Boundaries.
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
ApplyTo Gets or sets the ApplyTo.
Behavior Gets or sets the Behavior.
Children Gets the list of children.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the CoordinateSystem.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
HighBoundaryLocation Gets or sets the HighBoundaryLocation.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
LinearShift Gets or sets the LinearShift.
Location Gets or sets the Location.
LowBoundaryLocation Gets or sets the LowBoundaryLocation.
PeriodicityDirection Gets or sets the PeriodicityDirection.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
ScopeMode Gets the ScopeMode.
Suppressed Gets or sets the Suppressed.
SymmetryNormal Gets or sets the SymmetryNormal.
Type Gets or sets the Type.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property SymmetryRegion.ApplyTo : Ansys.Mechanical.DataModel.Enums.PeriodicApplyTo | None

Gets or sets the ApplyTo.

property SymmetryRegion.Behavior : Ansys.Mechanical.DataModel.Enums.SymmetryBehavior | None

Gets or sets the Behavior.

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

Gets the list of children.

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

Gets the list of associated comments.

property SymmetryRegion.CoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

property SymmetryRegion.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

property SymmetryRegion.HighBoundaryLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the HighBoundaryLocation.

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

Gets the list of associated images.

property SymmetryRegion.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSSymmetryGeneralAuto | None

Gets the internal object. For advanced usage only.

property SymmetryRegion.LinearShift : Ansys.Core.Units.Quantity | None

Gets or sets the LinearShift.

property SymmetryRegion.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property SymmetryRegion.LowBoundaryLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the LowBoundaryLocation.

property SymmetryRegion.PeriodicityDirection : Ansys.Mechanical.DataModel.Enums.PeriodicityDirectionType | None

Gets or sets the PeriodicityDirection.

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

Gets the list of properties for this object.

property SymmetryRegion.ReadOnly : bool | None

Gets or sets the ReadOnly.

property SymmetryRegion.ScopeMode : Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None

Gets the ScopeMode.

property SymmetryRegion.Suppressed : bool | None

Gets or sets the Suppressed.

property SymmetryRegion.SymmetryNormal : Ansys.Mechanical.DataModel.Enums.SymmetryNormalType | None

Gets or sets the SymmetryNormal.

property SymmetryRegion.Type : Ansys.Mechanical.DataModel.Enums.SymmetryRegionType | None

Gets or sets the Type.

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

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

Method detail

SymmetryRegion.Activate()

Activate the current object.

SymmetryRegion.AddComment()

Creates a new child Comment.

SymmetryRegion.AddFigure()

Creates a new child Figure.

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

SymmetryRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

SymmetryRegion.CreateParameter(propName: str)

Creates a new parameter for a Property.

SymmetryRegion.Delete()

Run the Delete action.

SymmetryRegion.Duplicate()

Creates a copy of the current DataModelObject.

SymmetryRegion.FlipHighLow()

Flips the High and Low Boundaries.

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

Gets the list of children, filtered by type.

SymmetryRegion.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

SymmetryRegion.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

SymmetryRegion.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

SymmetryRegion.PropertyByName(name: str)

Get a property by its unique name.

SymmetryRegion.RemoveParameter(propName: str)

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