SymmetryRegion

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

Bases: object

Defines a SymmetryRegion.

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.
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.
FlipHighLow	Flips the High and Low Boundaries.
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.

Properties

ApplyTo	Gets or sets the ApplyTo.
AttachedRefs	AttachedRefs property.
Behavior	Gets or sets the Behavior.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
HighBoundaryLocation	Gets or sets the HighBoundaryLocation.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
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.
SectorsNumber	Sectors Number.
State	State property.
Suppressed	Gets or sets the Suppressed.
SymmetryNormal	Gets or sets the SymmetryNormal.
TransferableObjectId	TransferableObjectId property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

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

Gets or sets the HighBoundaryLocation.

property SymmetryRegion.IconName: str | None

IconName property.

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

Gets the list of associated images.

property SymmetryRegion.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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.Name: str | None

Name property.

property SymmetryRegion.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property SymmetryRegion.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.SectorsNumber: int | None

Sectors Number.

property SymmetryRegion.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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.TransferableObjectId: str | None

TransferableObjectId property.

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() → None

Activate the current object.

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

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

Copies all visible properties from this object to another.

SymmetryRegion.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

Creates a new parameter for a Property.

SymmetryRegion.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

SymmetryRegion.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

SymmetryRegion.FlipHighLow() → None

Flips the High and Low Boundaries.

SymmetryRegion.GetAPIName(dispId: int) → str

Property name bound to dispId.

SymmetryRegion.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

SymmetryRegion.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

SymmetryRegion.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

SymmetryRegion.GetHashCode() → int

GetHashCode method.

SymmetryRegion.GetIconFile() → System.Byte

GetIconFile method.

SymmetryRegion.GetLifetimeService() → Any

GetLifetimeService method.

SymmetryRegion.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

SymmetryRegion.GetPath() → str

GetPath method.

SymmetryRegion.GetPropertyName(dispId: int) → str

GetPropertyName method.

SymmetryRegion.GetPropertyValue(name: str) → Any

GetPropertyValue method.

SymmetryRegion.GetType() → type

GetType method.

SymmetryRegion.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

SymmetryRegion.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

SymmetryRegion.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

SymmetryRegion.InitializeLifetimeService() → Any

InitializeLifetimeService method.

SymmetryRegion.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

SymmetryRegion.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

SymmetryRegion.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

SymmetryRegion.RemoveParameter(propName: str) → None

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

SymmetryRegion.ToString() → str

ToString method.