CyclicRegion
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.CyclicRegion#
Bases:
object
Defines a CyclicRegion.
Overview#
|
Flips the High and Low Boundaries. |
|
Run the Delete action. |
|
Gets the list of children, filtered by type. |
|
Gets the list of children, filtered by type. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Activate the current object. |
|
Copies all visible properties from this object to another. |
|
Creates a copy of the current DataModelObject. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its unique name. |
|
Get a property by its API name. |
|
Creates a new parameter for a Property. |
|
Gets the parameter corresponding to the given property. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Gets the internal object. For advanced usage only. |
|
Gets the current DataModelObject’s category. |
|
Gets the ScopeMode. |
|
Gets or sets the Suppressed. |
|
Gets or sets the CoordinateSystem. |
|
Gets or sets the Location. |
|
Gets or sets the HighBoundaryLocation. |
|
Gets or sets the LowBoundaryLocation. |
|
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets the list of associated figures. |
|
Gets the list of associated images. |
|
Gets or sets the ReadOnly. |
|
Gets the internal object. For advanced usage only. |
|
Gets the list of properties for this object. |
|
Gets the list of properties that are visible for this object. |
Property detail#
- property CyclicRegion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSSymmetryGeneralAuto | None
Gets the internal object. For advanced usage only.
- property CyclicRegion.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
- property CyclicRegion.ScopeMode: Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None
Gets the ScopeMode.
- property CyclicRegion.Suppressed: System.Boolean | None
Gets or sets the Suppressed.
- property CyclicRegion.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None
Gets or sets the CoordinateSystem.
- property CyclicRegion.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
- property CyclicRegion.HighBoundaryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the HighBoundaryLocation.
- property CyclicRegion.LowBoundaryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the LowBoundaryLocation.
- property CyclicRegion.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
- property CyclicRegion.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
- property CyclicRegion.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
- property CyclicRegion.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
- property CyclicRegion.ReadOnly: System.Boolean | None
Gets or sets the ReadOnly.
- property CyclicRegion.InternalObject: System.Object | None
Gets the internal object. For advanced usage only.
- property CyclicRegion.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
- property CyclicRegion.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail#
- CyclicRegion.FlipHighLow() System.Void
Flips the High and Low Boundaries.
- CyclicRegion.Delete() System.Void
Run the Delete action.
- CyclicRegion.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) System.Collections.Generic.IList[ChildrenType]
Gets the list of children, filtered by type.
- CyclicRegion.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.
- CyclicRegion.AddComment() Ansys.ACT.Automation.Mechanical.Comment
Creates a new child Comment.
- CyclicRegion.AddFigure() Ansys.ACT.Automation.Mechanical.Figure
Creates a new child Figure.
- CyclicRegion.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.
- CyclicRegion.Activate() System.Void
Activate the current object.
- CyclicRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) System.Void
Copies all visible properties from this object to another.
- CyclicRegion.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject
Creates a copy of the current DataModelObject.
- CyclicRegion.GroupAllSimilarChildren() System.Void
Run the GroupAllSimilarChildren action.
- CyclicRegion.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder
Run the GroupSimilarObjects action.
- CyclicRegion.PropertyByName(name: System.String) Ansys.ACT.Automation.Mechanical.Property
Get a property by its unique name.
- CyclicRegion.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.
- CyclicRegion.CreateParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter
Creates a new parameter for a Property.
- CyclicRegion.GetParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter
Gets the parameter corresponding to the given property.
- CyclicRegion.RemoveParameter(propName: System.String) System.Void
Removes the parameter from the parameter set corresponding to the given property.