BoltPretension

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

Bases: object

Defines a BoltPretension.

Overview

Methods

Activate	Activate the current object.
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.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDefineBy	Gets the Bolt Define By value at a given solution step.
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.
InitializeNumberOfSteps	InitializeNumberOfSteps method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PromoteToCoordinateSystem	Run the PromoteToCoordinateSystem action.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
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.
SetDefineBy	Sets the Bolt Define By value for a given solution step.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
CoordinateSystem	Gets or sets the CoordinateSystem.
CoordinateSystemBehavior	Gets or sets the CoordinateSystemBehavior.
DataModelObjectCategory	Gets the current DataModelObject's category.
DefineBy	Gets a value indicating how the bolt pretension is defined at the analysis' current step.
Figures	Gets the list of associated figures.
Formulation	Gets or sets the Formulation.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
Increment	Gets the Increment.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Preadjustment	Gets the Preadjustment.
Preload	Gets the Preload.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
SolveBehaviourType	Gets or sets the SolveBehaviourType.
State	State property.
Suppressed	Gets or sets the Suppressed.
Tolerance	Gets or sets the Tolerance.
TransferableObjectId	TransferableObjectId property.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property BoltPretension.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property BoltPretension.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property BoltPretension.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

property BoltPretension.CoordinateSystemBehavior: Ansys.Mechanical.DataModel.Enums.CoordinateSystemBehavior | None

Gets or sets the CoordinateSystemBehavior.

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

Gets the current DataModelObject's category.

property BoltPretension.DefineBy: Ansys.Mechanical.DataModel.Enums.BoltLoadDefineBy | None

Gets a value indicating how the bolt pretension is defined at the analysis' current step.

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

Gets the list of associated figures.

property BoltPretension.Formulation: Ansys.Mechanical.DataModel.Enums.FormulationType | None

Gets or sets the Formulation.

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

GroupingFolder property.

property BoltPretension.IconName: str | None

IconName property.

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

Gets the list of associated images.

property BoltPretension.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property BoltPretension.Increment: Ansys.ACT.Mechanical.Fields.Field | None

Gets the Increment.

property BoltPretension.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSPretensionBoltLoadAuto | None

Gets the internal object. For advanced usage only.

property BoltPretension.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property BoltPretension.Name: str | None

Name property.

property BoltPretension.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

property BoltPretension.Preadjustment: Ansys.ACT.Mechanical.Fields.Field | None

Gets the Preadjustment.

property BoltPretension.Preload: Ansys.ACT.Mechanical.Fields.Field | None

Gets the Preload.

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

Gets the list of properties for this object.

property BoltPretension.ReadOnly: bool | None

Gets or sets the ReadOnly.

property BoltPretension.SolveBehaviourType: Ansys.Mechanical.DataModel.Enums.SolveBehaviourType | None

Gets or sets the SolveBehaviourType.

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

State property.

property BoltPretension.Suppressed: bool | None

Gets or sets the Suppressed.

property BoltPretension.Tolerance: Ansys.Core.Units.Quantity | None

Gets or sets the Tolerance.

property BoltPretension.TransferableObjectId: str | None

TransferableObjectId property.

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

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

Method detail

BoltPretension.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

BoltPretension.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

BoltPretension.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

BoltPretension.GetDefineBy(stepNumber: int) → Ansys.Mechanical.DataModel.Enums.BoltLoadDefineBy

Gets the Bolt Define By value at a given solution step.

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

GetDetailsView method.

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

Enum name bound to value

BoltPretension.GetHashCode() → int

GetHashCode method.

BoltPretension.GetIconFile() → System.Byte

GetIconFile method.

BoltPretension.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

BoltPretension.GetPath() → str

GetPath method.

BoltPretension.GetPropertyName(dispId: int) → str

GetPropertyName method.

BoltPretension.GetPropertyValue(name: str) → Any

GetPropertyValue method.

BoltPretension.GetType() → type

GetType method.

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

GetVisibleProperties method.

BoltPretension.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

BoltPretension.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

BoltPretension.InitializeLifetimeService() → Any

InitializeLifetimeService method.

BoltPretension.InitializeNumberOfSteps(numSteps: int) → None

InitializeNumberOfSteps method.

BoltPretension.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

BoltPretension.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

BoltPretension.PromoteToCoordinateSystem() → Iterable[Ansys.ACT.Automation.Mechanical.CoordinateSystem]

Run the PromoteToCoordinateSystem action.

BoltPretension.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

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

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

PropertyById method.

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

Get a property by its unique name.

BoltPretension.RemoveParameter(propName: str) → None

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

BoltPretension.SetDefineBy(stepNumber: int, type: Ansys.Mechanical.DataModel.Enums.BoltLoadDefineBy) → None

Sets the Bolt Define By value for a given solution step.

BoltPretension.ToString() → str

ToString method.