class Ansys.ACT.Automation.Mechanical.Criterion

Bases: object

Defines a Criterion.

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.
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.
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.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property Criterion.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSTopoCriterionAuto | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property Criterion.ReadOnly : bool | None

Gets or sets the ReadOnly.

property Criterion.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

Criterion.Activate()

Activate the current object.

Criterion.AddComment()

Creates a new child Comment.

Criterion.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

Criterion.CreateParameter(propName: str)

Creates a new parameter for a Property.

Criterion.Delete()

Run the Delete action.

Criterion.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

Criterion.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

Criterion.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

Criterion.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

Criterion.PropertyByName(name: str)

Get a property by its unique name.

Criterion.RemoveParameter(propName: str)

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