FileBasedImportedLoads

class ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.FileBasedImportedLoads

Bases: object

Defines a FileBasedImportedLoads

Overview

Methods

Activate	Activate the current object.
CopyTo	Copies all visible properties from this object to another.
CreateParameter	Creates a new parameter for a Property.
Duplicate	Creates a copy of the current DataModelObject.
GetParameter	Gets the parameter corresponding to the given property.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects 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.

Properties

BCType	Gets or sets the BCType
DataModelObjectCategory	Gets the current DataModelObject's category.
InternalObject	Gets the internal object. For advanced usage only.
Magnitude	Gets the Magnitude.
MagnitudeImag	Gets the MagnitudeImag.
Properties	Gets the list of properties for this object.
RemotePoint	Get and set the remote point.
RpmSelection	Gets or sets the RPMSelection.
VisibleProperties	Gets the list of properties that are visible for this object.
XComponent	Gets the XComponent.
XComponentImag	Gets the XComponentImag.
YComponent	Gets the YComponent.
YComponentImag	Gets the YComponentImag.
ZComponent	Gets the ZComponent.
ZComponentImag	Gets the ZComponentImag.

Property detail

property FileBasedImportedLoads.BCType: Ansys.Mechanical.DataModel.Enums.ImportedRemoteLoadType | None

Gets or sets the BCType

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

Gets the current DataModelObject's category.

property FileBasedImportedLoads.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSFileBasedImportedLoadsAuto | None

Gets the internal object. For advanced usage only.

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

Gets the Magnitude.

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

Gets the MagnitudeImag.

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

Gets the list of properties for this object.

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

Get and set the remote point.

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

Gets or sets the RPMSelection.

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

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

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

Gets the XComponent.

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

Gets the XComponentImag.

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

Gets the YComponent.

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

Gets the YComponentImag.

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

Gets the ZComponent.

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

Gets the ZComponentImag.

Method detail

FileBasedImportedLoads.Activate() → None

Activate the current object.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

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

Creates a copy of the current DataModelObject.

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

Gets the parameter corresponding to the given property.

FileBasedImportedLoads.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

FileBasedImportedLoads.RemoveParameter(propName: str) → None

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