ExpansionSettings#

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

Bases: object

Defines a ExpansionSettings.

Overview#

Activate

Activate the current object.

AddComment

Creates a new child Comment.

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

ClearGeneratedData

Run the ClearGeneratedData action.

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.

EvaluateAllResults

Run the EvaluateAllResults action.

GetChildren

Gets the list of children, filtered by type.

GetCompletedExpansionState

Gets the completed expansion state of a given Condensed Part

GetExpansionState

Gets the requested expansion state of a given Condensed Part

GetParameter

Gets the parameter corresponding to the given property.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

PerformExpansionPass

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

SetExpansionState

Sets the requested expansion state of a given Condensed Part

Children

Gets the list of children.

CleanupOptionalFiles

Gets or sets the CleanupOptionalFiles.

Comments

Gets the list of associated comments.

CondensedPartExpansionType

Gets or sets the CondensedPartExpansionType.

DataModelObjectCategory

Gets the current DataModelObject's category.

ExpandAfterUsePassFailure

Gets or sets the ExpandAfterUsePassFailure.

Figures

Gets the list of associated figures.

GeneralMiscellaneous

Gets or sets the GeneralMiscellaneous.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

NodalForces

Gets or sets the NodalForces.

Properties

Gets the list of properties for this object.

Strain

Gets or sets the Strain.

Stress

Gets or sets the Stress.

Suppressed

Gets or sets the Suppressed.

VisibleProperties

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

Property detail#

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

Gets the list of children.

property ExpansionSettings.CleanupOptionalFiles: bool | None#

Gets or sets the CleanupOptionalFiles.

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

Gets the list of associated comments.

property ExpansionSettings.CondensedPartExpansionType: Ansys.Mechanical.DataModel.Enums.CondensedPartExpansionType | None#

Gets or sets the CondensedPartExpansionType.

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

Gets the current DataModelObject's category.

property ExpansionSettings.ExpandAfterUsePassFailure: bool | None#

Gets or sets the ExpandAfterUsePassFailure.

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

Gets the list of associated figures.

property ExpansionSettings.GeneralMiscellaneous: bool | None#

Gets or sets the GeneralMiscellaneous.

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

Gets the list of associated images.

property ExpansionSettings.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSExpansionSettingsAuto | None#

Gets the internal object. For advanced usage only.

property ExpansionSettings.NodalForces: Ansys.Mechanical.DataModel.Enums.OutputControlsNodalForcesType | None#

Gets or sets the NodalForces.

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

Gets the list of properties for this object.

property ExpansionSettings.Strain: bool | None#

Gets or sets the Strain.

property ExpansionSettings.Stress: bool | None#

Gets or sets the Stress.

property ExpansionSettings.Suppressed: bool | None#

Gets or sets the Suppressed.

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

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

Method detail#

ExpansionSettings.Activate() None#

Activate the current object.

ExpansionSettings.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

ExpansionSettings.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

ExpansionSettings.AddImage(filePath: str) 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.
ExpansionSettings.ClearGeneratedData() None#

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

ExpansionSettings.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

ExpansionSettings.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Gets the list of children, filtered by type.

ExpansionSettings.GetCompletedExpansionState(condensedPart: Ansys.ACT.Automation.Mechanical.CondensedPart) Ansys.ACT.Automation.Mechanical.CondensedPartExpansionState#

Gets the completed expansion state of a given Condensed Part

ExpansionSettings.GetExpansionState(condensedPart: Ansys.ACT.Automation.Mechanical.CondensedPart) Ansys.ACT.Automation.Mechanical.CondensedPartExpansionState#

Gets the requested expansion state of a given Condensed Part

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

Gets the parameter corresponding to the given property.

ExpansionSettings.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

ExpansionSettings.PerformExpansionPass() None#

Run the PerformExpansionPass action.

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

Get a property by its unique name.

ExpansionSettings.RemoveParameter(propName: str) None#

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

ExpansionSettings.SetExpansionState(condensedPart: Ansys.ACT.Automation.Mechanical.CondensedPart, state: Ansys.ACT.Automation.Mechanical.CondensedPartExpansionState) None#

Sets the requested expansion state of a given Condensed Part