RemoteForce

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

Bases: object

Defines a RemoteForce.

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 remote force 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.
PromoteToRemotePoint	Run the PromoteToRemotePoint 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 remote force is active at the specified load step.
SetComponentActivateAtLoadStep	SetComponentActivateAtLoadStep method.
ToString	ToString method.

Properties

ApplyToRigidBodyPilotNode	Gets or sets the ApplyToRigidBodyPilotNode.
AttachedRefs	AttachedRefs property.
BeamMaterial	Gets or sets the BeamMaterial.
BeamRadius	Gets or sets the BeamRadius.
Behavior	Gets or sets the Behavior.
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.
Figures	Gets the list of associated figures.
FollowerLoad	Gets or sets the FollowerLoad.
GroupingFolder	GroupingFolder property.
HarmonicIndex	Gets or sets the HarmonicIndex.
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.
LoadVectorAssignment
LoadVectorNumber
LoadVectorNumberImaginary
LoadVectorNumberX
LoadVectorNumberXImaginary
LoadVectorNumberY
LoadVectorNumberYImaginary
LoadVectorNumberZ
LoadVectorNumberZImaginary
LoadingApplicationType	Gets or sets the LoadingApplicationType.
Location	Gets or sets the Location.
Magnitude	Gets the Magnitude.
MagnitudeImag	Gets the MagnitudeImag.
Name	Name property.
NonCyclicLoadingType	Gets or sets the NonCyclicLoadingType.
NumberOfSegments	Gets or sets the NumberOfSegments.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
PhaseAngle	Gets the PhaseAngle.
PinballRegion	Gets or sets the PinballRegion.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
RpmSelection	Gets or sets the RPMSelection.
RpmVarying	Gets or sets the RpmVarying.
SectorNumber	Gets or sets the SectorNumber.
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.
XCoordinate	Gets or sets the XCoordinate.
XPhaseAngle	Gets the XPhaseAngle.
YComponent	Gets the YComponent.
YComponentImag	Gets the YComponentImag.
YCoordinate	Gets or sets the YCoordinate.
YPhaseAngle	Gets the YPhaseAngle.
ZComponent	Gets the ZComponent.
ZComponentImag	Gets the ZComponentImag.
ZCoordinate	Gets or sets the ZCoordinate.
ZPhaseAngle	Gets the ZPhaseAngle.

Property detail

property RemoteForce.ApplyToRigidBodyPilotNode: bool | None

Gets or sets the ApplyToRigidBodyPilotNode.

property RemoteForce.AttachedRefs: List[int] | None

AttachedRefs property.

property RemoteForce.BeamMaterial: str | None

Gets or sets the BeamMaterial.

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

Gets or sets the BeamRadius.

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

Gets or sets the Behavior.

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

Gets the list of children.

property RemoteForce.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject's category.

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

Gets or sets the DefineBy.

property RemoteForce.Direction: Ansys.ACT.Math.Vector3D | None

Gets or sets the Direction.

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

Gets the list of associated figures.

property RemoteForce.FollowerLoad: bool | None

Gets or sets the FollowerLoad.

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

GroupingFolder property.

property RemoteForce.HarmonicIndex: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the HarmonicIndex.

property RemoteForce.IconName: str | None

IconName property.

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

Gets the list of associated images.

property RemoteForce.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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

Gets or sets the IndependentVariable.

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

Gets the internal object. For advanced usage only.

property RemoteForce.LoadStepVarying: bool | None

Gets or sets the LoadStepVarying.

property RemoteForce.LoadVectorAssignment: Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment | None

property RemoteForce.LoadVectorNumber: int | None

property RemoteForce.LoadVectorNumberImaginary: int | None

property RemoteForce.LoadVectorNumberX: int | None

property RemoteForce.LoadVectorNumberXImaginary: int | None

property RemoteForce.LoadVectorNumberY: int | None

property RemoteForce.LoadVectorNumberYImaginary: int | None

property RemoteForce.LoadVectorNumberZ: int | None

property RemoteForce.LoadVectorNumberZImaginary: int | None

property RemoteForce.LoadingApplicationType: Ansys.Mechanical.DataModel.Enums.LoadingApplicationType | None

Gets or sets the LoadingApplicationType.

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

Gets or sets the Location.

property RemoteForce.Magnitude: Ansys.ACT.Mechanical.Fields.Field | None

Gets the Magnitude.

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

Gets the MagnitudeImag.

property RemoteForce.Name: str | None

Name property.

property RemoteForce.NonCyclicLoadingType: Ansys.Mechanical.DataModel.Enums.NonCyclicLoadingType | None

Gets or sets the NonCyclicLoadingType.

property RemoteForce.NumberOfSegments: int | None

Gets or sets the NumberOfSegments.

property RemoteForce.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

Gets the PhaseAngle.

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

Gets or sets the PinballRegion.

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

Gets the list of properties for this object.

property RemoteForce.ReadOnly: bool | None

Gets or sets the ReadOnly.

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

Gets or sets the RPMSelection.

property RemoteForce.RpmVarying: bool | None

Gets or sets the RpmVarying.

property RemoteForce.SectorNumber: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the SectorNumber.

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

Gets or sets the SharedRefBody.

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

State property.

property RemoteForce.StepSelection: int | None

Gets or sets the StepSelection.

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

Gets or sets the StepVarying.

property RemoteForce.Suppressed: bool | None

Gets or sets the Suppressed.

property RemoteForce.TransferableObjectId: str | None

TransferableObjectId property.

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

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

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

Gets the XComponent.

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

Gets the XComponentImag.

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

Gets or sets the XCoordinate.

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

Gets the XPhaseAngle.

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

Gets the YComponent.

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

Gets the YComponentImag.

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

Gets or sets the YCoordinate.

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

Gets the YPhaseAngle.

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

Gets the ZComponent.

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

Gets the ZComponentImag.

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

Gets or sets the ZCoordinate.

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

Gets the ZPhaseAngle.

Method detail

RemoteForce.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

RemoteForce.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

RemoteForce.GetAPIName(dispId: int) → str

Property name bound to dispId.

RemoteForce.GetActivateAtLoadStep(stepNumber: int) → bool

Gets whether the remote force is active at the specified load step.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetComponentActivateAtLoadStep method.

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

GetDetailsView method.

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

Enum name bound to value

RemoteForce.GetHashCode() → int

GetHashCode method.

RemoteForce.GetIconFile() → System.Byte

GetIconFile method.

RemoteForce.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

RemoteForce.GetPath() → str

GetPath method.

RemoteForce.GetPropertyName(dispId: int) → str

GetPropertyName method.

RemoteForce.GetPropertyValue(name: str) → Any

GetPropertyValue method.

RemoteForce.GetType() → type

GetType method.

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

GetVisibleProperties method.

RemoteForce.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

RemoteForce.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

RemoteForce.InitializeLifetimeService() → Any

InitializeLifetimeService method.

RemoteForce.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

RemoteForce.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

Run the PromoteToNamedSelection action.

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

Run the PromoteToRemotePoint action.

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

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

PropertyById method.

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

Get a property by its unique name.

RemoteForce.RemoveParameter(propName: str) → None

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

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

Sets whether the remote force is active at the specified load step.

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

SetComponentActivateAtLoadStep method.

RemoteForce.ToString() → str

ToString method.