`JointLoad`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.JointLoad#

Bases: object

Defines a JointLoad.

Overview#

Methods

`GetActivateAtLoadStep`	GetActivateAtLoadStep method.
`SetActivateAtLoadStep`	SetActivateAtLoadStep method.
`AddCommandSnippet`	Creates a new CommandSnippet
`RenameBasedOnDefinition`	Run the RenameBasedOnDefinition action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`NumberOfSegments`	Gets or sets the NumberOfSegments.
`FittingMethod`	Gets or sets the FittingMethod.
`CutoffFrequency`	Gets or sets the CutoffFrequency.
`InternalObject`	Gets the internal object. For advanced usage only.
`LockAtLoadStep`	Gets or sets the LockAtLoadStep.
`Magnitude`	Gets the Magnitude.
`DOF`	Gets or sets the DOF.
`JointConditionType`	Gets or sets the JointConditionType.
`Suppressed`	Gets or sets the Suppressed.
`Joint`	Gets or sets the Joint.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property JointLoad.NumberOfSegments: System.UInt32 | None: Gets or sets the NumberOfSegments.

property JointLoad.FittingMethod: Ansys.Mechanical.DataModel.Enums.FittingMethodType | None: Gets or sets the FittingMethod.

property JointLoad.CutoffFrequency: System.Double | None: Gets or sets the CutoffFrequency.

property JointLoad.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSJointConditionAuto | None: Gets the internal object. For advanced usage only.

property JointLoad.LockAtLoadStep: System.UInt32 | None: Gets or sets the LockAtLoadStep.

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

property JointLoad.DOF: Ansys.Mechanical.DataModel.Enums.KinematicDOF | None: Gets or sets the DOF.

property JointLoad.JointConditionType: Ansys.Mechanical.DataModel.Enums.JointConditionType | None: Gets or sets the JointConditionType.

property JointLoad.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property JointLoad.Joint: Ansys.ACT.Automation.Mechanical.DataModelObject | None: Gets or sets the Joint.

property JointLoad.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property JointLoad.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property JointLoad.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property JointLoad.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property JointLoad.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property JointLoad.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property JointLoad.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property JointLoad.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

JointLoad.GetActivateAtLoadStep(stepNumber: System.UInt32) → System.Boolean: GetActivateAtLoadStep method.

JointLoad.SetActivateAtLoadStep(stepNumber: System.UInt32, bActive: System.Boolean) → System.Void: SetActivateAtLoadStep method.

JointLoad.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet: Creates a new CommandSnippet

JointLoad.RenameBasedOnDefinition() → System.Void: Run the RenameBasedOnDefinition action.

JointLoad.Delete() → System.Void: Run the Delete action.

JointLoad.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

JointLoad.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

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: System.String) → 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.Activate() → System.Void: Activate the current object.

JointLoad.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

JointLoad.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

JointLoad.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

JointLoad.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

JointLoad.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

JointLoad.PropertyByAPIName(name: System.String) → 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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

JointLoad.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

JointLoad.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.