Joint

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

Bases: object

Defines a Joint.

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.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
FlipReferenceMobile	Run the FlipReferenceMobile action.
GetAPIName	Property name bound to dispId.
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.
GetTableGenerator	GetTableGenerator 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.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PromoteToRemotePoint	Run the PromoteToRemotePoint 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.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
BushingWorksheet	Returns the Bushing Coeffients worksheet associated with Bushing Joint.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
ConnectionType	Gets or sets the ConnectionType.
CurveOrientationSurface	Gets or sets the CurveOrientationSurface.
DataModelObjectCategory	Gets the current DataModelObject's category.
EffectiveLength	Gets or sets the EffectiveLength.
ElementCoordinateSystem	Gets or sets the ElementCoordinateSystem.
Figures	Gets the list of associated figures.
Formulation	Gets or sets the Formulation.
FrictionCoefficient	Gets or sets the FrictionCoefficient.
GeneralPrimitiveType	Gets or sets the GeneralPrimitiveType.
GloballyAvailable	Gets or sets the GloballyAvailable.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
InitialPosition	Gets or sets the InitialPosition.
InnerRadius	Gets or sets the InnerRadius.
InternalObject	Gets the internal object. For advanced usage only.
JointElementAPDLName	Gets or sets the JointElementAPDLName.
JointFrictionType	Gets or sets the JointFrictionType.
MobileAppliedBy	Gets or sets the MobileAppliedBy.
MobileBeamCoincidentLengthFactor	Gets or sets the Coincident Length Factor on mobile side that scales the stiffness of the connection between the beam elements and the remote point. This property is applicable when the Behavior property is set to “Beam”. Default: 1.
MobileBeamMaterial	Gets or sets the MobileBeamMaterial.
MobileBeamRadius	Gets or sets the MobileBeamRadius.
MobileBehavior	Gets or sets the MobileBehavior.
MobileBody	Gets the MobileBody.
MobileCoordinateSystem	Gets or sets the MobileCoordinateSystem.
MobileFormulation	Gets or sets the MobileFormulation.
MobileLocation	Gets or sets the MobileLocation.
MobileNodeId	Returns Mobile Node Id.
MobilePinballRegion	Gets or sets the MobilePinballRegion.
MobileRelaxationMethod	Gets or sets the MobileRelaxationMethod.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OuterRadius	Gets or sets the OuterRadius.
Parent	Parent property.
Properties	Gets the list of properties for this object.
RXMaximum	Gets or sets the RXMaximum.
RXMaximumType	Gets or sets the RXMaximumType.
RXMinimum	Gets or sets the RXMinimum.
RXMinimumType	Gets or sets the RXMinimumType.
RYMaximum	Gets or sets the RYMaximum.
RYMaximumType	Gets or sets the RYMaximumType.
RYMinimum	Gets or sets the RYMinimum.
RYMinimumType	Gets or sets the RYMinimumType.
RZMaximum	Gets or sets the RZMaximum.
RZMaximumType	Gets or sets the RZMaximumType.
RZMinimum	Gets or sets the RZMinimum.
RZMinimumType	Gets or sets the RZMinimumType.
RadialGapHeight	Gets or sets the RadialGapHeight.
RadialGapInnerDiameter	Gets or sets the RadialGapInnerDiameter.
RadialGapType	Gets or sets the RadialGapType.
RadialOuterDiameter	Gets or sets the RadialOuterDiameter.
Radius	Gets or sets the Radius.
ReadOnly	Gets or sets the ReadOnly.
ReferenceAppliedBy	Gets or sets the ReferenceAppliedBy.
ReferenceBeamCoincidentLengthFactor	Gets or sets the Coincident Length Factor on reference side that scales the stiffness of the connection between the beam elements and the remote point. This property is applicable when the Behavior property is set to “Beam”. Default: 1.
ReferenceBeamMaterial	Gets or sets the ReferenceBeamMaterial.
ReferenceBeamRadius	Gets or sets the ReferenceBeamRadius.
ReferenceBehavior	Gets or sets the ReferenceBehavior.
ReferenceBody	Gets the ReferenceBody.
ReferenceCoordinateSystem	Gets or sets the ReferenceCoordinateSystem.
ReferenceFormulation	Gets or sets the ReferenceFormulation.
ReferenceLocation	Gets or sets the ReferenceLocation.
ReferenceNodeId	Returns Reference Node Id.
ReferencePinballRegion	Gets or sets the ReferencePinballRegion.
ReferenceRelaxationMethod	Gets or sets the ReferenceRelaxationMethod.
RestitutionFactor	Gets or sets the RestitutionFactor.
Rotations	Gets or sets the Rotations.
ScrewPitch	Gets or sets the ScrewPitch.
SolverElementType	Gets or sets the SolverElementType.
State	State property.
Suppressed	Gets or sets the Suppressed.
SuppressedForSolve	Gets the SuppressedForSolve.
TorsionalDamping	Gets or sets the TorsionalDamping.
TorsionalStiffness	Gets or sets the TorsionalStiffness.
TransferableObjectId	TransferableObjectId property.
TranslationX	Gets or sets the TranslationX.
TranslationY	Gets or sets the TranslationY.
TranslationZ	Gets or sets the TranslationZ.
Type	Gets or sets the Type.
VisibleProperties	Gets the list of properties that are visible for this object.
XMaximum	Gets or sets the XMaximum.
XMaximumType	Gets or sets the XMaximumType.
XMinimum	Gets or sets the XMinimum.
XMinimumType	Gets or sets the XMinimumType.
YMaximum	Gets or sets the YMaximum.
YMaximumType	Gets or sets the YMaximumType.
YMinimum	Gets or sets the YMinimum.
YMinimumType	Gets or sets the YMinimumType.
ZMaximum	Gets or sets the ZMaximum.
ZMaximumType	Gets or sets the ZMaximumType.
ZMinimum	Gets or sets the ZMinimum.
ZMinimumType	Gets or sets the ZMinimumType.

Property detail

property Joint.AttachedRefs: List[int] | None

AttachedRefs property.

property Joint.BushingWorksheet: Ansys.ACT.Interfaces.Common.IWorksheet | None

Returns the Bushing Coeffients worksheet associated with Bushing Joint.

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

Gets the list of children.

property Joint.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property Joint.ConnectionType: Ansys.Mechanical.DataModel.Enums.JointScopingType | None

Gets or sets the ConnectionType.

property Joint.CurveOrientationSurface: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the CurveOrientationSurface.

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

Gets the current DataModelObject's category.

property Joint.EffectiveLength: Ansys.Core.Units.Quantity | None

Gets or sets the EffectiveLength.

property Joint.ElementCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the ElementCoordinateSystem.

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

Gets the list of associated figures.

property Joint.Formulation: Ansys.Mechanical.DataModel.Enums.JointFormulation | None

Gets or sets the Formulation.

property Joint.FrictionCoefficient: float | None

Gets or sets the FrictionCoefficient.

property Joint.GeneralPrimitiveType: Ansys.Mechanical.DataModel.Enums.JointGeneralPrimitiveType | None

Gets or sets the GeneralPrimitiveType.

property Joint.GloballyAvailable: bool | None

Gets or sets the GloballyAvailable.

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

GroupingFolder property.

property Joint.IconName: str | None

IconName property.

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

Gets the list of associated images.

property Joint.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property Joint.InitialPosition: Ansys.Mechanical.DataModel.Enums.JointInitialPosition | None

Gets or sets the InitialPosition.

property Joint.InnerRadius: Ansys.Core.Units.Quantity | None

Gets or sets the InnerRadius.

property Joint.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSJointAuto | None

Gets the internal object. For advanced usage only.

property Joint.JointElementAPDLName: str | None

Gets or sets the JointElementAPDLName.

property Joint.JointFrictionType: Ansys.Mechanical.DataModel.Enums.JointFrictionType | None

Gets or sets the JointFrictionType.

property Joint.MobileAppliedBy: Ansys.Mechanical.DataModel.Enums.RemoteApplicationType | None

Gets or sets the MobileAppliedBy.

property Joint.MobileBeamCoincidentLengthFactor: float | None

Gets or sets the Coincident Length Factor on mobile side that scales the stiffness of the connection between the beam elements and the remote point. This property is applicable when the Behavior property is set to “Beam”. Default: 1.

property Joint.MobileBeamMaterial: str | None

Gets or sets the MobileBeamMaterial.

property Joint.MobileBeamRadius: Ansys.Core.Units.Quantity | None

Gets or sets the MobileBeamRadius.

property Joint.MobileBehavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the MobileBehavior.

property Joint.MobileBody: str | None

Gets the MobileBody.

property Joint.MobileCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the MobileCoordinateSystem.

property Joint.MobileFormulation: Ansys.Mechanical.DataModel.Enums.RemotePointFormulation | None

Gets or sets the MobileFormulation.

property Joint.MobileLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the MobileLocation.

property Joint.MobileNodeId: int | None

Returns Mobile Node Id.

property Joint.MobilePinballRegion: Ansys.Core.Units.Quantity | None

Gets or sets the MobilePinballRegion.

property Joint.MobileRelaxationMethod: bool | None

Gets or sets the MobileRelaxationMethod.

property Joint.Name: str | None

Name property.

property Joint.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property Joint.OuterRadius: Ansys.Core.Units.Quantity | None

Gets or sets the OuterRadius.

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

Parent property.

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

Gets the list of properties for this object.

property Joint.RXMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the RXMaximum.

property Joint.RXMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RXMaximumType.

property Joint.RXMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the RXMinimum.

property Joint.RXMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RXMinimumType.

property Joint.RYMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the RYMaximum.

property Joint.RYMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RYMaximumType.

property Joint.RYMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the RYMinimum.

property Joint.RYMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RYMinimumType.

property Joint.RZMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the RZMaximum.

property Joint.RZMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RZMaximumType.

property Joint.RZMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the RZMinimum.

property Joint.RZMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RZMinimumType.

property Joint.RadialGapHeight: Ansys.Core.Units.Quantity | None

Gets or sets the RadialGapHeight.

property Joint.RadialGapInnerDiameter: Ansys.Core.Units.Quantity | None

Gets or sets the RadialGapInnerDiameter.

property Joint.RadialGapType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RadialGapType.

property Joint.RadialOuterDiameter: Ansys.Core.Units.Quantity | None

Gets or sets the RadialOuterDiameter.

property Joint.Radius: Ansys.Core.Units.Quantity | None

Gets or sets the Radius.

property Joint.ReadOnly: bool | None

Gets or sets the ReadOnly.

property Joint.ReferenceAppliedBy: Ansys.Mechanical.DataModel.Enums.RemoteApplicationType | None

Gets or sets the ReferenceAppliedBy.

property Joint.ReferenceBeamCoincidentLengthFactor: float | None

Gets or sets the Coincident Length Factor on reference side that scales the stiffness of the connection between the beam elements and the remote point. This property is applicable when the Behavior property is set to “Beam”. Default: 1.

property Joint.ReferenceBeamMaterial: str | None

Gets or sets the ReferenceBeamMaterial.

property Joint.ReferenceBeamRadius: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceBeamRadius.

property Joint.ReferenceBehavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the ReferenceBehavior.

property Joint.ReferenceBody: str | None

Gets the ReferenceBody.

property Joint.ReferenceCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the ReferenceCoordinateSystem.

property Joint.ReferenceFormulation: Ansys.Mechanical.DataModel.Enums.RemotePointFormulation | None

Gets or sets the ReferenceFormulation.

property Joint.ReferenceLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the ReferenceLocation.

property Joint.ReferenceNodeId: int | None

Returns Reference Node Id.

property Joint.ReferencePinballRegion: Ansys.Core.Units.Quantity | None

Gets or sets the ReferencePinballRegion.

property Joint.ReferenceRelaxationMethod: bool | None

Gets or sets the ReferenceRelaxationMethod.

property Joint.RestitutionFactor: float | None

Gets or sets the RestitutionFactor.

property Joint.Rotations: Ansys.Mechanical.DataModel.Enums.JointRotationDOFType | None

Gets or sets the Rotations.

property Joint.ScrewPitch: Ansys.Core.Units.Quantity | None

Gets or sets the ScrewPitch.

property Joint.SolverElementType: Ansys.Mechanical.DataModel.Enums.JointSolverElementType | None

Gets or sets the SolverElementType.

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

State property.

property Joint.Suppressed: bool | None

Gets or sets the Suppressed.

property Joint.SuppressedForSolve: bool | None

Gets the SuppressedForSolve.

property Joint.TorsionalDamping: Ansys.Core.Units.Quantity | None

Gets or sets the TorsionalDamping.

property Joint.TorsionalStiffness: Ansys.Core.Units.Quantity | None

Gets or sets the TorsionalStiffness.

property Joint.TransferableObjectId: str | None

TransferableObjectId property.

property Joint.TranslationX: Ansys.Mechanical.DataModel.Enums.FixedOrFree | None

Gets or sets the TranslationX.

property Joint.TranslationY: Ansys.Mechanical.DataModel.Enums.FixedOrFree | None

Gets or sets the TranslationY.

property Joint.TranslationZ: Ansys.Mechanical.DataModel.Enums.FixedOrFree | None

Gets or sets the TranslationZ.

property Joint.Type: Ansys.Mechanical.DataModel.Enums.JointType | None

Gets or sets the Type.

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

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

property Joint.XMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the XMaximum.

property Joint.XMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the XMaximumType.

property Joint.XMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the XMinimum.

property Joint.XMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the XMinimumType.

property Joint.YMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the YMaximum.

property Joint.YMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the YMaximumType.

property Joint.YMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the YMinimum.

property Joint.YMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the YMinimumType.

property Joint.ZMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the ZMaximum.

property Joint.ZMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the ZMaximumType.

property Joint.ZMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the ZMinimum.

property Joint.ZMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the ZMinimumType.

Method detail

Joint.Activate() → None

Activate the current object.

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

Creates a new CommandSnippet

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

Joint.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

Joint.FlipReferenceMobile() → None

Run the FlipReferenceMobile action.

Joint.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

Joint.GetHashCode() → int

GetHashCode method.

Joint.GetIconFile() → System.Byte

GetIconFile method.

Joint.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

Joint.GetPath() → str

GetPath method.

Joint.GetPropertyName(dispId: int) → str

GetPropertyName method.

Joint.GetPropertyValue(name: str) → Any

GetPropertyValue method.

Joint.GetTableGenerator() → Ansys.ACT.Automation.Mechanical.Connections.ConnectionsTableGenerator

GetTableGenerator method.

Joint.GetType() → type

GetType method.

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

GetVisibleProperties method.

Joint.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

Joint.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Joint.InitializeLifetimeService() → Any

InitializeLifetimeService method.

Joint.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

Joint.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

Run the PromoteToNamedSelection action.

Joint.PromoteToRemotePoint() → Iterable[Ansys.ACT.Automation.Mechanical.RemotePoint]

Run the PromoteToRemotePoint action.

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

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

PropertyById method.

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

Get a property by its unique name.

Joint.RemoveParameter(propName: str) → None

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

Joint.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

Joint.ToString() → str

ToString method.