JointLoad

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

Bases: object

Defines a JointLoad.

Overview

Methods

Activate	Activate the current object.
AddCommandSnippet	Creates a new CommandSnippet
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.
DoesRequireTableFitting	DoesRequireTableFitting method.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetActivateAtLoadStep	Gets whether the joint is active at the specified load step.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
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.
GetTableFittingData	GetTableFittingData 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.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
SetActivateAtLoadStep	Sets whether the joint is active at the specified load step.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
CutoffFrequency	Gets or sets the CutoffFrequency.
DOF	Gets or sets the DOF.
DataModelObjectCategory	Gets the current DataModelObject's category.
Figures	Gets the list of associated figures.
FittingMethod	Gets or sets the FittingMethod.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Joint	Gets or sets the Joint.
JointConditionType	Gets or sets the JointConditionType.
LockAtLoadStep	Gets or sets the LockAtLoadStep.
Magnitude	Gets the Magnitude.
Name	Name property.
NumberOfSegments	Gets or sets the NumberOfSegments.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
State	State property.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property JointLoad.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property JointLoad.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property JointLoad.CutoffFrequency: float | None

Gets or sets the CutoffFrequency.

property JointLoad.DOF: Ansys.Mechanical.DataModel.Enums.KinematicDOF | None

Gets or sets the DOF.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property JointLoad.FittingMethod: Ansys.Mechanical.DataModel.Enums.FittingMethodType | None

Gets or sets the FittingMethod.

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

GroupingFolder property.

property JointLoad.IconName: str | None

IconName property.

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

Gets the list of associated images.

property JointLoad.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSJointConditionAuto | None

Gets the internal object. For advanced usage only.

property JointLoad.Joint: Ansys.ACT.Automation.Mechanical.DataModelObject | None

Gets or sets the Joint.

property JointLoad.JointConditionType: Ansys.Mechanical.DataModel.Enums.JointConditionType | None

Gets or sets the JointConditionType.

property JointLoad.LockAtLoadStep: int | None

Gets or sets the LockAtLoadStep.

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

Gets the Magnitude.

property JointLoad.Name: str | None

Name property.

property JointLoad.NumberOfSegments: int | None

Gets or sets the NumberOfSegments.

property JointLoad.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

Gets the list of properties for this object.

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

State property.

property JointLoad.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

Method detail

JointLoad.Activate() → None

Activate the current object.

JointLoad.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet

Creates a new CommandSnippet

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

JointLoad.Delete() → None

Run the Delete action.

JointLoad.DoesRequireTableFitting() → bool

DoesRequireTableFitting method.

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

Creates a copy of the current DataModelObject.

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

Equals method.

JointLoad.GetAPIName(dispId: int) → str

Property name bound to dispId.

JointLoad.GetActivateAtLoadStep(stepNumber: int) → bool

Gets whether the joint is active at the specified load step.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

JointLoad.GetHashCode() → int

GetHashCode method.

JointLoad.GetIconFile() → System.Byte

GetIconFile method.

JointLoad.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

JointLoad.GetPath() → str

GetPath method.

JointLoad.GetPropertyName(dispId: int) → str

GetPropertyName method.

JointLoad.GetPropertyValue(name: str) → Any

GetPropertyValue method.

JointLoad.GetTableFittingData() → tuple[tuple[float]]

GetTableFittingData method.

JointLoad.GetType() → type

GetType method.

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

GetVisibleProperties method.

JointLoad.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

JointLoad.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

JointLoad.InitializeLifetimeService() → Any

InitializeLifetimeService method.

JointLoad.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

JointLoad.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

JointLoad.RemoveParameter(propName: str) → None

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

JointLoad.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

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

Sets whether the joint is active at the specified load step.

JointLoad.ToString() → str

ToString method.