PeriodicRegion

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.PeriodicRegion

Bases: object

Defines a PeriodicRegion.

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

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.
Location	Gets or sets the Location.
LowBoundaryLocation	Gets or sets the LowBoundaryLocation.
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.
Type	Gets or sets the Type.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

Gets or sets the HighBoundaryLocation.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

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

Gets or sets the LowBoundaryLocation.

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

Gets the list of properties for this object.

property PeriodicRegion.ReadOnly: bool | None

Gets or sets the ReadOnly.

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

Gets the ScopeMode.

property PeriodicRegion.Suppressed: bool | None

Gets or sets the Suppressed.

property PeriodicRegion.Type: Ansys.Mechanical.DataModel.Enums.PeriodicRegionType | None

Gets or sets the Type.

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

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

Method detail

PeriodicRegion.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

PeriodicRegion.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

PeriodicRegion.FlipHighLow() → None

Flips the High and Low Boundaries.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

PeriodicRegion.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

PeriodicRegion.RemoveParameter(propName: str) → None

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