TreeGroupingFolder#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Bases: object

Defines a TreeGroupingFolder.

Overview#

Activate

Activate the current object.

CopyTo

Copies all visible properties from this object to another.

CreateParameter

Creates a new parameter for a Property.

DeleteTreeGroupAndChildren

Run the DeleteTreeGroupAndChildren 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.

Children

Gets the list of children.

ChildrenInGroup

Gets the ChildrenInGroup.

DataModelObjectCategory

Gets the current DataModelObject's category.

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 TreeGroupingFolder.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets the list of children.

property TreeGroupingFolder.ChildrenInGroup: int | None#

Gets the ChildrenInGroup.

property TreeGroupingFolder.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property TreeGroupingFolder.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTreeGroupingFolderAuto | None#

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property TreeGroupingFolder.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property TreeGroupingFolder.Suppressed: bool | None#

Gets or sets the Suppressed.

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

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

Method detail#

TreeGroupingFolder.Activate() None#

Activate the current object.

TreeGroupingFolder.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

TreeGroupingFolder.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

TreeGroupingFolder.DeleteTreeGroupAndChildren() None#

Run the DeleteTreeGroupAndChildren action.

TreeGroupingFolder.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

TreeGroupingFolder.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

TreeGroupingFolder.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

TreeGroupingFolder.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

TreeGroupingFolder.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.
TreeGroupingFolder.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

TreeGroupingFolder.RemoveParameter(propName: str) None#

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