DisplacementConstraint

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.DisplacementConstraint(internalObject: Any)

Bases: object

Defines a DisplacementConstraint.

Overview

Methods

Activate	Activate the current object.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
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.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
DataModelObjectCategory	Gets the current DataModelObject's category.
EnvironmentSelection	Gets or Sets the EnvironmentSelection to an Analysis object or TopoEnvironmentType enum.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
ScopingMethod	Gets or sets the ScopingMethod.
State	State property.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.
XComponentMax	Gets or sets the XComponentMax.
YComponentMax	Gets or sets the YComponentMax.
ZComponentMax	Gets or sets the ZComponentMax.

Property detail

property DisplacementConstraint.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property DisplacementConstraint.ClsId: int | None

ClsId property.

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

Gets the current DataModelObject's category.

property DisplacementConstraint.EnvironmentSelection: Any | None

Gets or Sets the EnvironmentSelection to an Analysis object or TopoEnvironmentType enum.

property DisplacementConstraint.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property DisplacementConstraint.IconName: str | None

IconName property.

property DisplacementConstraint.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTopoConstraintAuto | None

Gets the internal object. For advanced usage only.

property DisplacementConstraint.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property DisplacementConstraint.Name: str | None

Name property.

property DisplacementConstraint.ObjectId: int | None

ObjectId property.

property DisplacementConstraint.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property DisplacementConstraint.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property DisplacementConstraint.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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

Gets the list of properties for this object.

property DisplacementConstraint.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property DisplacementConstraint.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property DisplacementConstraint.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

property DisplacementConstraint.XComponentMax: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the XComponentMax.

property DisplacementConstraint.YComponentMax: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the YComponentMax.

property DisplacementConstraint.ZComponentMax: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the ZComponentMax.

Method detail

DisplacementConstraint.Activate() → None

Activate the current object.

DisplacementConstraint.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

DisplacementConstraint.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

DisplacementConstraint.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

DisplacementConstraint.Delete() → None

Run the Delete action.

DisplacementConstraint.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

DisplacementConstraint.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

DisplacementConstraint.GetAPIName(dispId: int) → str

Property name bound to dispId.

DisplacementConstraint.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

DisplacementConstraint.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

DisplacementConstraint.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

DisplacementConstraint.GetHashCode() → int

GetHashCode method.

DisplacementConstraint.GetIconFile() → System.Byte

GetIconFile method.

DisplacementConstraint.GetLifetimeService() → Any

GetLifetimeService method.

DisplacementConstraint.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

DisplacementConstraint.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

DisplacementConstraint.GetPath() → str

GetPath method.

DisplacementConstraint.GetPropertyName(dispId: int) → str

GetPropertyName method.

DisplacementConstraint.GetPropertyValue(name: str) → Any

GetPropertyValue method.

DisplacementConstraint.GetType() → type

GetType method.

DisplacementConstraint.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

DisplacementConstraint.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

DisplacementConstraint.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

DisplacementConstraint.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

DisplacementConstraint.InitializeLifetimeService() → Any

InitializeLifetimeService method.

DisplacementConstraint.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

DisplacementConstraint.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

DisplacementConstraint.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

DisplacementConstraint.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

DisplacementConstraint.RemoveParameter(propName: str) → None

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

DisplacementConstraint.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

DisplacementConstraint.ToString() → str

ToString method.