HousingConstraint#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.HousingConstraint#

Bases: object

Defines a HousingConstraint.

Overview#

Activate

Activate the current object.

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.

RenameBasedOnDefinition

Run the RenameBasedOnDefinition action.

Children

Gets the list of children.

DataModelObjectCategory

Gets the current DataModelObject's category.

HousingLocation

Gets or sets the HousingLocation.

HousingScopingMethod

Gets or sets the HousingScopingMethod.

InternalObject

Gets the internal object. For advanced usage only.

Location

Gets or sets the Location.

Properties

Gets the list of properties for this object.

ScopingMethod

Gets or sets the ScopingMethod.

Selection

Gets or sets the Selection.

Suppressed

Gets or sets the Suppressed.

VisibleProperties

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

Property detail#

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

Gets the list of children.

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

Gets the current DataModelObject's category.

property HousingConstraint.HousingLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the HousingLocation.

property HousingConstraint.HousingScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#

Gets or sets the HousingScopingMethod.

property HousingConstraint.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTopoConstraintAuto | None#

Gets the internal object. For advanced usage only.

property HousingConstraint.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

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

Gets the list of properties for this object.

property HousingConstraint.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#

Gets or sets the ScopingMethod.

property HousingConstraint.Selection: Ansys.ACT.Automation.Mechanical.OptimizationRegion | None#

Gets or sets the Selection.

property HousingConstraint.Suppressed: bool | None#

Gets or sets the Suppressed.

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

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

Method detail#

HousingConstraint.Activate() None#

Activate the current object.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

HousingConstraint.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

HousingConstraint.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Get a property by its unique name.

HousingConstraint.RemoveParameter(propName: str) None#

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

HousingConstraint.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.