FileBasedImportedLoads

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

Bases: object

Defines a FileBasedImportedLoads

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.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties 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.
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.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
BCType	Gets or sets the BCType
ClsId	ClsId property.
DataModelObjectCategory	Gets the current DataModelObject's category.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
InternalObject	Gets the internal object. For advanced usage only.
Magnitude	Gets the Magnitude.
MagnitudeImag	Gets the MagnitudeImag.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
RemotePoint	Get and set the remote point.
RpmSelection	Gets or sets the RPMSelection.
State	State property.
VisibleProperties	Gets the list of properties that are visible for this object.
XComponent	Gets the XComponent.
XComponentForce	XComponentForce property.
XComponentImag	Gets the XComponentImag.
XComponentImagForce	XComponentImagForce property.
XComponentImagMoment	XComponentImagMoment property.
XComponentMoment	XComponentMoment property.
YComponent	Gets the YComponent.
YComponentForce	YComponentForce property.
YComponentImag	Gets the YComponentImag.
YComponentImagForce	YComponentImagForce property.
YComponentImagMoment	YComponentImagMoment property.
YComponentMoment	YComponentMoment property.
ZComponent	Gets the ZComponent.
ZComponentForce	ZComponentForce property.
ZComponentImag	Gets the ZComponentImag.
ZComponentImagForce	ZComponentImagForce property.
ZComponentImagMoment	ZComponentImagMoment property.
ZComponentMoment	ZComponentMoment property.

Property detail

property FileBasedImportedLoads.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets or sets the BCType

property FileBasedImportedLoads.ClsId: int | None

ClsId property.

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

Gets the current DataModelObject's category.

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

GroupingFolder property.

property FileBasedImportedLoads.IconName: str | None

IconName property.

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.Name: str | None

Name property.

property FileBasedImportedLoads.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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.XComponentForce: Ansys.ACT.Mechanical.Fields.Field | None

XComponentForce property.

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

Gets the XComponentImag.

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

XComponentImagForce property.

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

XComponentImagMoment property.

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

XComponentMoment property.

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

Gets the YComponent.

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

YComponentForce property.

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

Gets the YComponentImag.

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

YComponentImagForce property.

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

YComponentImagMoment property.

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

YComponentMoment property.

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

Gets the ZComponent.

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

ZComponentForce property.

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

Gets the ZComponentImag.

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

ZComponentImagForce property.

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

ZComponentImagMoment property.

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

ZComponentMoment property.

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.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

FileBasedImportedLoads.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

GetDetailsView method.

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

Enum name bound to value

FileBasedImportedLoads.GetHashCode() → int

GetHashCode method.

FileBasedImportedLoads.GetIconFile() → System.Byte

GetIconFile method.

FileBasedImportedLoads.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

FileBasedImportedLoads.GetPath() → str

GetPath method.

FileBasedImportedLoads.GetPropertyName(dispId: int) → str

GetPropertyName method.

FileBasedImportedLoads.GetPropertyValue(name: str) → Any

GetPropertyValue method.

FileBasedImportedLoads.GetType() → type

GetType method.

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

GetVisibleProperties method.

FileBasedImportedLoads.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

FileBasedImportedLoads.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

FileBasedImportedLoads.InitializeLifetimeService() → Any

InitializeLifetimeService method.

FileBasedImportedLoads.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

FileBasedImportedLoads.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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.

FileBasedImportedLoads.ToString() → str

ToString method.