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