`SymmetryRegion`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.SymmetryRegion#

Bases: object

Defines a SymmetryRegion.

Overview#

Methods

`FlipHighLow`	Flips the High and Low Boundaries.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`PeriodicityDirection`	Gets or sets the PeriodicityDirection.
`Location`	Gets or sets the Location.
`LinearShift`	Gets or sets the LinearShift.
`InternalObject`	Gets the internal object. For advanced usage only.
`ApplyTo`	Gets or sets the ApplyTo.
`Behavior`	Gets or sets the Behavior.
`SymmetryNormal`	Gets or sets the SymmetryNormal.
`Type`	Gets or sets the Type.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`ScopeMode`	Gets the ScopeMode.
`Suppressed`	Gets or sets the Suppressed.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`HighBoundaryLocation`	Gets or sets the HighBoundaryLocation.
`LowBoundaryLocation`	Gets or sets the LowBoundaryLocation.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property SymmetryRegion.PeriodicityDirection: Ansys.Mechanical.DataModel.Enums.PeriodicityDirectionType | None: Gets or sets the PeriodicityDirection.

property SymmetryRegion.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property SymmetryRegion.LinearShift: Ansys.Core.Units.Quantity | None: Gets or sets the LinearShift.

property SymmetryRegion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSSymmetryGeneralAuto | None: Gets the internal object. For advanced usage only.

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.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.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

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

property SymmetryRegion.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property SymmetryRegion.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the CoordinateSystem.

property SymmetryRegion.HighBoundaryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the HighBoundaryLocation.

property SymmetryRegion.LowBoundaryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the LowBoundaryLocation.

property SymmetryRegion.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property SymmetryRegion.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property SymmetryRegion.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property SymmetryRegion.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property SymmetryRegion.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property SymmetryRegion.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property SymmetryRegion.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property SymmetryRegion.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

SymmetryRegion.FlipHighLow() → System.Void: Flips the High and Low Boundaries.

SymmetryRegion.Delete() → System.Void: Run the Delete action.

SymmetryRegion.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

SymmetryRegion.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

SymmetryRegion.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

SymmetryRegion.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

SymmetryRegion.AddImage(filePath: System.String) → 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.

SymmetryRegion.Activate() → System.Void: Activate the current object.

SymmetryRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

SymmetryRegion.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

SymmetryRegion.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

SymmetryRegion.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

SymmetryRegion.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

SymmetryRegion.PropertyByAPIName(name: System.String) → 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.

SymmetryRegion.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

SymmetryRegion.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

SymmetryRegion.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.