Skip to main content

Mechanical scripting interface

Deviation

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.MeshControls.Deviation

Bases: object

Defines a Deviation.

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.
GenerateMesh Generate the Mesh.
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.
RenameBasedOnDefinition Run the RenameBasedOnDefinition action.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
ControlType Gets or sets the SagControlType.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
MeshSize MeshSize property.
NamedSelection Gets or sets the NamedSelection.
NumberOfDivisions NumberOfDivisions property.
Properties Gets the list of properties for this object.
ScopingMethod Gets or sets the ScopingMethod.
Suppressed Gets or sets the Suppressed.
Tolerance Tolerance property.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

property Deviation.ControlType : Ansys.Mechanical.DataModel.Enums.DeviationControlType | None

Gets or sets the SagControlType.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property Deviation.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSMeshControlAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property Deviation.MeshSize : Ansys.Core.Units.Quantity | None

MeshSize property.

property Deviation.NamedSelection : Ansys.ACT.Automation.Mechanical.NamedSelection | None

Gets or sets the NamedSelection.

property Deviation.NumberOfDivisions : int | None

NumberOfDivisions property.

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

Gets the list of properties for this object.

property Deviation.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property Deviation.Suppressed : bool | None

Gets or sets the Suppressed.

property Deviation.Tolerance : Ansys.Core.Units.Quantity | None

Tolerance property.

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

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

Method detail

Deviation.Activate()

Activate the current object.

Deviation.AddComment()

Creates a new child Comment.

Deviation.AddFigure()

Creates a new child Figure.

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

Deviation.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

Deviation.CreateParameter(propName: str)

Creates a new parameter for a Property.

Deviation.Delete()

Run the Delete action.

Deviation.Duplicate()

Creates a copy of the current DataModelObject.

Deviation.GenerateMesh()

Generate the Mesh.

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

Gets the list of children, filtered by type.

Deviation.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

Deviation.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

Deviation.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

Deviation.PropertyByName(name: str)

Get a property by its unique name.

Deviation.RemoveParameter(propName: str)

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

Deviation.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.