Displacement

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

Bases: object

Defines a Displacement.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
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.
GetActivateAtLoadStep	Gets whether the displacement is active at the specified load step.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetComponentActivateAtLoadStep	GetComponentActivateAtLoadStep method.
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.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
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.
SetActivateAtLoadStep	Sets whether the displacement is active at the specified load step.
SetComponentActivateAtLoadStep	SetComponentActivateAtLoadStep method.
ToString	ToString method.

Properties

AbsoluteResult	Gets or sets the AbsoluteResult.
AttachedRefs	AttachedRefs property.
BaseExcitation	Gets or sets the BaseExcitation.
BoundaryCondition	Gets or sets the BoundaryCondition.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
CoordinateSystem	Gets or sets the CoordinateSystem.
DataModelObjectCategory	Gets the current DataModelObject's category.
DefineBy	Gets or sets the DefineBy.
Direction	Gets or sets the Direction.
Distance	Gets the Distance.
DynamicRelaxationBehavior	Gets or sets the DynamicRelaxationBehavior.
Figures	Gets the list of associated figures.
GraphControlsXAxis	Gets or sets the GraphControlsXAxis.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
IndependentVariable	Gets or sets the IndependentVariable.
InternalObject	Gets the internal object. For advanced usage only.
LoadStepVarying	Gets or sets the LoadStepVarying.
Location	Gets or sets the Location.
MagnitudeImag	Gets the MagnitudeImag.
Name	Name property.
NumberOfSegments	Gets or sets the NumberOfSegments.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
PhaseAngle	Gets the PhaseAngle.
Properties	Gets the list of properties for this object.
RangeMaximum	Gets or sets the RangeMaximum.
RangeMinimum	Gets or sets the RangeMinimum.
ReadOnly	Gets or sets the ReadOnly.
ReverseDirectionForInverseSteps	Gets or sets the ReverseDirectionForInverseSteps.
RpmSelection	Gets or sets the RPMSelection.
RpmVarying	Gets or sets the RpmVarying.
SharedRefBody	Gets or sets the SharedRefBody.
State	State property.
StepSelection	Gets or sets the StepSelection.
StepVarying	Gets or sets the StepVarying.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
VisibleProperties	Gets the list of properties that are visible for this object.
XComponent	Gets the XComponent.
XComponentImag	Gets the XComponentImag.
XPhaseAngle	Gets the XPhaseAngle.
XYZFunctionCoordinateSystem	Gets or sets the XYZFunctionCoordinateSystem.
YComponent	Gets the YComponent.
YComponentImag	Gets the YComponentImag.
YPhaseAngle	Gets the YPhaseAngle.
ZComponent	Gets the ZComponent.
ZComponentImag	Gets the ZComponentImag.
ZPhaseAngle	Gets the ZPhaseAngle.

Property detail

property Displacement.AbsoluteResult: bool | None

Gets or sets the AbsoluteResult.

property Displacement.AttachedRefs: List[int] | None

AttachedRefs property.

property Displacement.BaseExcitation: bool | None

Gets or sets the BaseExcitation.

property Displacement.BoundaryCondition: Any | None

Gets or sets the BoundaryCondition.

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

Gets the list of children.

property Displacement.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property Displacement.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject's category.

property Displacement.DefineBy: Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None

Gets or sets the DefineBy.

property Displacement.Direction: Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None

Gets or sets the Direction.

property Displacement.Distance: Ansys.ACT.Mechanical.Fields.Field | None

Gets the Distance.

property Displacement.DynamicRelaxationBehavior: Ansys.Mechanical.DataModel.Enums.DynamicRelaxationBehaviorType | None

Gets or sets the DynamicRelaxationBehavior.

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

Gets the list of associated figures.

property Displacement.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the GraphControlsXAxis.

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

GroupingFolder property.

property Displacement.IconName: str | None

IconName property.

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

Gets the list of associated images.

property Displacement.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property Displacement.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the IndependentVariable.

property Displacement.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None

Gets the internal object. For advanced usage only.

property Displacement.LoadStepVarying: bool | None

Gets or sets the LoadStepVarying.

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

Gets or sets the Location.

property Displacement.MagnitudeImag: Ansys.ACT.Mechanical.Fields.Field | None

Gets the MagnitudeImag.

property Displacement.Name: str | None

Name property.

property Displacement.NumberOfSegments: int | None

Gets or sets the NumberOfSegments.

property Displacement.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

property Displacement.PhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None

Gets the PhaseAngle.

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

Gets the list of properties for this object.

property Displacement.RangeMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the RangeMaximum.

property Displacement.RangeMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the RangeMinimum.

property Displacement.ReadOnly: bool | None

Gets or sets the ReadOnly.

property Displacement.ReverseDirectionForInverseSteps: bool | None

Gets or sets the ReverseDirectionForInverseSteps.

property Displacement.RpmSelection: Ansys.Core.Units.Quantity | None

Gets or sets the RPMSelection.

property Displacement.RpmVarying: bool | None

Gets or sets the RpmVarying.

property Displacement.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None

Gets or sets the SharedRefBody.

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

State property.

property Displacement.StepSelection: int | None

Gets or sets the StepSelection.

property Displacement.StepVarying: Ansys.Mechanical.DataModel.Enums.StepVarying | None

Gets or sets the StepVarying.

property Displacement.Suppressed: bool | None

Gets or sets the Suppressed.

property Displacement.TransferableObjectId: str | None

TransferableObjectId property.

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

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

property Displacement.XComponent: Ansys.ACT.Mechanical.Fields.Field | None

Gets the XComponent.

property Displacement.XComponentImag: Ansys.ACT.Mechanical.Fields.Field | None

Gets the XComponentImag.

property Displacement.XPhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None

Gets the XPhaseAngle.

property Displacement.XYZFunctionCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the XYZFunctionCoordinateSystem.

property Displacement.YComponent: Ansys.ACT.Mechanical.Fields.Field | None

Gets the YComponent.

property Displacement.YComponentImag: Ansys.ACT.Mechanical.Fields.Field | None

Gets the YComponentImag.

property Displacement.YPhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None

Gets the YPhaseAngle.

property Displacement.ZComponent: Ansys.ACT.Mechanical.Fields.Field | None

Gets the ZComponent.

property Displacement.ZComponentImag: Ansys.ACT.Mechanical.Fields.Field | None

Gets the ZComponentImag.

property Displacement.ZPhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None

Gets the ZPhaseAngle.

Method detail

Displacement.Activate() → None

Activate the current object.

Displacement.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

Displacement.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

Displacement.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

Displacement.GetAPIName(dispId: int) → str

Property name bound to dispId.

Displacement.GetActivateAtLoadStep(stepNumber: int) → bool

Gets whether the displacement is active at the specified load step.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

Displacement.GetComponentActivateAtLoadStep(component: str, stepNumber: int) → bool

GetComponentActivateAtLoadStep method.

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

GetDetailsView method.

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

Enum name bound to value

Displacement.GetHashCode() → int

GetHashCode method.

Displacement.GetIconFile() → System.Byte

GetIconFile method.

Displacement.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

Displacement.GetPath() → str

GetPath method.

Displacement.GetPropertyName(dispId: int) → str

GetPropertyName method.

Displacement.GetPropertyValue(name: str) → Any

GetPropertyValue method.

Displacement.GetType() → type

GetType method.

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

GetVisibleProperties method.

Displacement.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

Displacement.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Displacement.InitializeLifetimeService() → Any

InitializeLifetimeService method.

Displacement.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

Displacement.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

Displacement.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

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

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

PropertyById method.

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

Get a property by its unique name.

Displacement.RemoveParameter(propName: str) → None

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

Displacement.SetActivateAtLoadStep(stepNumber: int, bActive: bool) → None

Sets whether the displacement is active at the specified load step.

Displacement.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool) → None

SetComponentActivateAtLoadStep method.

Displacement.ToString() → str

ToString method.