RemoteDisplacement

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.RemoteDisplacement

Bases: object

Defines a RemoteDisplacement.

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.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
GetActivateAtLoadStep	GetActivateAtLoadStep method.
GetChildren	Gets the list of children, filtered by type.
GetComponentActivateAtLoadStep	GetComponentActivateAtLoadStep method.
GetParameter	Gets the parameter corresponding to the given property.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PromoteToRemotePoint	Run the PromoteToRemotePoint 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.
SetActivateAtLoadStep	SetActivateAtLoadStep method.
SetComponentActivateAtLoadStep	SetComponentActivateAtLoadStep method.

Properties

BeamMaterial	Gets or sets the BeamMaterial.
BeamRadius	Gets or sets the BeamRadius.
Behavior	Gets or sets the Behavior.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
CoordinateSystem	Gets or sets the CoordinateSystem.
DataModelObjectCategory	Gets the current DataModelObject's category.
DynamicRelaxationBehavior	Gets or sets the DynamicRelaxationBehavior.
Figures	Gets the list of associated figures.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Geometry.
NumberOfSegments	Gets or sets the NumberOfSegments.
PinballRegion	Gets or sets the PinballRegion.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
RemotePoint	Gets the remote point associated to the point mass.
ReverseDirectionForInverseSteps	Gets or sets the ReverseDirectionForInverseSteps.
RotationX	Gets the RotationX.
RotationY	Gets the RotationY.
RotationZ	Gets the RotationZ.
SharedRefBody	Gets or sets the SharedRefBody.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.
XComponent	Gets the XComponent.
XCoordinate	Gets or sets the XCoordinate.
YComponent	Gets the YComponent.
YCoordinate	Gets or sets the YCoordinate.
ZComponent	Gets the ZComponent.
ZCoordinate	Gets or sets the ZCoordinate.

Property detail

property RemoteDisplacement.BeamMaterial: str | None

Gets or sets the BeamMaterial.

property RemoteDisplacement.BeamRadius: Ansys.Core.Units.Quantity | None

Gets or sets the BeamRadius.

property RemoteDisplacement.Behavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the Behavior.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject's category.

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

Gets or sets the DynamicRelaxationBehavior.

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

Gets the list of associated figures.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the Geometry.

property RemoteDisplacement.NumberOfSegments: int | None

Gets or sets the NumberOfSegments.

property RemoteDisplacement.PinballRegion: Ansys.Core.Units.Quantity | None

Gets or sets the PinballRegion.

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

Gets the list of properties for this object.

property RemoteDisplacement.ReadOnly: bool | None

Gets or sets the ReadOnly.

property RemoteDisplacement.RemotePoint: Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets the remote point associated to the point mass.

property RemoteDisplacement.ReverseDirectionForInverseSteps: bool | None

Gets or sets the ReverseDirectionForInverseSteps.

property RemoteDisplacement.RotationX: Ansys.ACT.Mechanical.Fields.Field | None

Gets the RotationX.

property RemoteDisplacement.RotationY: Ansys.ACT.Mechanical.Fields.Field | None

Gets the RotationY.

property RemoteDisplacement.RotationZ: Ansys.ACT.Mechanical.Fields.Field | None

Gets the RotationZ.

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

Gets or sets the SharedRefBody.

property RemoteDisplacement.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

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

Gets the XComponent.

property RemoteDisplacement.XCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the XCoordinate.

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

Gets the YComponent.

property RemoteDisplacement.YCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the YCoordinate.

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

Gets the ZComponent.

property RemoteDisplacement.ZCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the ZCoordinate.

Method detail

RemoteDisplacement.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

RemoteDisplacement.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

RemoteDisplacement.GetActivateAtLoadStep(stepNumber: int) → bool

GetActivateAtLoadStep method.

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

Gets the list of children, filtered by type.

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

GetComponentActivateAtLoadStep method.

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

Gets the parameter corresponding to the given property.

RemoteDisplacement.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Run the PromoteToNamedSelection action.

RemoteDisplacement.PromoteToRemotePoint() → Iterable[Ansys.ACT.Automation.Mechanical.RemotePoint]

Run the PromoteToRemotePoint action.

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

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

Get a property by its unique name.

RemoteDisplacement.RemoveParameter(propName: str) → None

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

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

SetActivateAtLoadStep method.

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

SetComponentActivateAtLoadStep method.