`HousingConstraint`#

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

Defines a HousingConstraint.

Overview#

Methods

`RenameBasedOnDefinition`	Run the RenameBasedOnDefinition action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`HousingScopingMethod`	Gets or sets the HousingScopingMethod.
`HousingLocation`	Gets or sets the HousingLocation.
`InternalObject`	Gets the internal object. For advanced usage only.
`ScopingMethod`	Gets or sets the ScopingMethod.
`Location`	Gets or sets the Location.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Suppressed`	Gets or sets the Suppressed.
`Selection`	Gets or sets the Selection.
`Children`	Gets the list of children.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

property HousingConstraint.HousingScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None: Gets or sets the HousingScopingMethod.

property HousingConstraint.HousingLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the HousingLocation.

property HousingConstraint.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTopoConstraintAuto | None: Gets the internal object. For advanced usage only.

property HousingConstraint.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None: Gets or sets the ScopingMethod.

property HousingConstraint.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property HousingConstraint.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property HousingConstraint.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property HousingConstraint.Selection: Ansys.ACT.Automation.Mechanical.OptimizationRegion | None: Gets or sets the Selection.

property HousingConstraint.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property HousingConstraint.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property HousingConstraint.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property HousingConstraint.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

HousingConstraint.RenameBasedOnDefinition() → System.Void: Run the RenameBasedOnDefinition action.

HousingConstraint.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

HousingConstraint.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

HousingConstraint.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

HousingConstraint.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

HousingConstraint.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

HousingConstraint.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

HousingConstraint.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

HousingConstraint.PropertyByAPIName(name: System.String) → 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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

HousingConstraint.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

HousingConstraint.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.