IMechanicalUserLoad

class ansys.mechanical.stubs.v241.Ansys.ACT.Interfaces.Mechanical.IMechanicalUserLoad

Bases: object

Defines a Mechanical user load.

Overview

Methods

CreateChild	CreateChild method.
NotifyChange	NotifyChange method.
SetDefaultSelection	Sets the default selection of the entity.
get_AffectsSolution	get_AffectsSolution method.
get_AllProperties	get_AllProperties method.
get_Analysis	get_Analysis method.
get_Attributes	get_Attributes method.
get_Caption	get_Caption method.
get_Children	get_Children method.
get_Color	get_Color method.
get_Controller	get_Controller method.
get_Extension	get_Extension method.
get_Icon	get_Icon method.
get_Id	get_Id method.
get_InternalCaption	get_InternalCaption method.
get_IsLoad	get_IsLoad method.
get_IsSupport	get_IsSupport method.
get_Name	get_Name method.
get_ObjectLocation	get_ObjectLocation method.
get_ObjectType	get_ObjectType method.
get_Parent	get_Parent method.
get_Properties	get_Properties method.
get_State	get_State method.
get_SupportedLocations	get_SupportedLocations method.
get_Suppressed	get_Suppressed method.
get_Version	get_Version method.
set_Color	set_Color method.
set_Suppressed	set_Suppressed method.

Properties

AffectsSolution	AffectsSolution property.
AllProperties	AllProperties property.
Analysis	Gets the associated analysis.
Attributes	Attributes property.
Caption	Caption property.
Children	Children property.
Color	Color property.
Controller	Controller property.
Extension	Extension property.
Icon	Icon property.
Id	Id property.
InternalCaption	InternalCaption property.
IsLoad	IsLoad property.
IsSupport	IsSupport property.
Name	Name property.
ObjectLocation	ObjectLocation property.
ObjectType	ObjectType property.
Parent	Parent property.
Properties	Properties property.
State	State property.
SupportedLocations	SupportedLocations property.
Suppressed	Suppressed property.
Version	Version property.

Property detail

property IMechanicalUserLoad.AffectsSolution: bool | None

AffectsSolution property.

property IMechanicalUserLoad.AllProperties: Iterable[Ansys.ACT.Interfaces.UserObject.ISimProperty] | None

AllProperties property.

property IMechanicalUserLoad.Analysis: Ansys.ACT.Interfaces.Analysis.IAnalysis | None

Gets the associated analysis.

property IMechanicalUserLoad.Attributes: Ansys.ACT.Interfaces.Common.IAttributeCollection | None

Attributes property.

property IMechanicalUserLoad.Caption: str | None

Caption property.

property IMechanicalUserLoad.Children: Iterable[Ansys.ACT.Interfaces.UserObject.IUserObject] | None

Children property.

property IMechanicalUserLoad.Color: int | None

Color property.

property IMechanicalUserLoad.Controller: Any | None

Controller property.

property IMechanicalUserLoad.Extension: Ansys.ACT.Interfaces.Common.IExtension | None

Extension property.

property IMechanicalUserLoad.Icon: str | None

Icon property.

property IMechanicalUserLoad.Id: int | None

Id property.

property IMechanicalUserLoad.InternalCaption: str | None

InternalCaption property.

property IMechanicalUserLoad.IsLoad: bool | None

IsLoad property.

property IMechanicalUserLoad.IsSupport: bool | None

IsSupport property.

property IMechanicalUserLoad.Name: str | None

Name property.

property IMechanicalUserLoad.ObjectLocation: Ansys.ACT.Interfaces.UserObject.ObjectLocationEnum | None

ObjectLocation property.

property IMechanicalUserLoad.ObjectType: Ansys.ACT.Interfaces.UserObject.ObjectTypeEnum | None

ObjectType property.

property IMechanicalUserLoad.Parent: Ansys.ACT.Interfaces.DataModel.IDataModelObject | None

Parent property.

property IMechanicalUserLoad.Properties: Ansys.ACT.Interfaces.UserObject.IPropertyCollection | None

Properties property.

property IMechanicalUserLoad.State: str | None

State property.

property IMechanicalUserLoad.SupportedLocations: Ansys.ACT.Interfaces.UserObject.ObjectLocationEnum | None

SupportedLocations property.

property IMechanicalUserLoad.Suppressed: bool | None

Suppressed property.

property IMechanicalUserLoad.Version: int | None

Version property.

Method detail

IMechanicalUserLoad.CreateChild(name: str) → Ansys.ACT.Interfaces.UserObject.IUserLoad

CreateChild method.

IMechanicalUserLoad.NotifyChange() → None

NotifyChange method.

IMechanicalUserLoad.SetDefaultSelection(selection: Ansys.ACT.Interfaces.Common.ISelectionInfo, notifyChange: bool) → None

Sets the default selection of the entity.

IMechanicalUserLoad.get_AffectsSolution() → bool

get_AffectsSolution method.

IMechanicalUserLoad.get_AllProperties() → Iterable[Ansys.ACT.Interfaces.UserObject.ISimProperty]

get_AllProperties method.

IMechanicalUserLoad.get_Analysis() → Ansys.ACT.Interfaces.Analysis.IAnalysis

get_Analysis method.

IMechanicalUserLoad.get_Attributes() → Ansys.ACT.Interfaces.Common.IAttributeCollection

get_Attributes method.

IMechanicalUserLoad.get_Caption() → str

get_Caption method.

IMechanicalUserLoad.get_Children() → Iterable[Ansys.ACT.Interfaces.UserObject.IUserObject]

get_Children method.

IMechanicalUserLoad.get_Color() → int

get_Color method.

IMechanicalUserLoad.get_Controller() → Any

get_Controller method.

IMechanicalUserLoad.get_Extension() → Ansys.ACT.Interfaces.Common.IExtension

get_Extension method.

IMechanicalUserLoad.get_Icon() → str

get_Icon method.

IMechanicalUserLoad.get_Id() → int

get_Id method.

IMechanicalUserLoad.get_InternalCaption() → str

get_InternalCaption method.

IMechanicalUserLoad.get_IsLoad() → bool

get_IsLoad method.

IMechanicalUserLoad.get_IsSupport() → bool

get_IsSupport method.

IMechanicalUserLoad.get_Name() → str

get_Name method.

IMechanicalUserLoad.get_ObjectLocation() → Ansys.ACT.Interfaces.UserObject.ObjectLocationEnum

get_ObjectLocation method.

IMechanicalUserLoad.get_ObjectType() → Ansys.ACT.Interfaces.UserObject.ObjectTypeEnum

get_ObjectType method.

IMechanicalUserLoad.get_Parent() → Ansys.ACT.Interfaces.DataModel.IDataModelObject

get_Parent method.

IMechanicalUserLoad.get_Properties() → Ansys.ACT.Interfaces.UserObject.IPropertyCollection

get_Properties method.

IMechanicalUserLoad.get_State() → str

get_State method.

IMechanicalUserLoad.get_SupportedLocations() → Ansys.ACT.Interfaces.UserObject.ObjectLocationEnum

get_SupportedLocations method.

IMechanicalUserLoad.get_Suppressed() → bool

get_Suppressed method.

IMechanicalUserLoad.get_Version() → int

get_Version method.

IMechanicalUserLoad.set_Color(value: int) → None

set_Color method.

IMechanicalUserLoad.set_Suppressed(value: bool) → None

set_Suppressed method.