Spring

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Connections.Spring

Bases: object

Defines a Spring.

Overview

Methods

PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PromoteToRemotePoint	Run the PromoteToRemotePoint action.
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

NonLinearLongitudinalStiffness	Gets the non linear longitudinal stiffness defined in the tabular data.
LongitudinalStiffness	Gets or sets the constant longitudinal stiffness (expressed in N/m).
InternalObject	Gets the internal object. For advanced usage only.
Material	Gets or sets the Material.
MobileBeamMaterial	Gets or sets the MobileBeamMaterial.
MobileBody	Gets the MobileBody.
ReferenceBeamMaterial	Gets or sets the ReferenceBeamMaterial.
ReferenceBody	Gets the ReferenceBody.
SpringElementAPDLName	Gets or sets the SpringElementAPDLName.
MobileBeamRadius	Gets or sets the MobileBeamRadius.
MobileXCoordinate	Gets or sets the MobileXCoordinate.
MobileYCoordinate	Gets or sets the MobileYCoordinate.
MobileZCoordinate	Gets or sets the MobileZCoordinate.
ReferenceBeamRadius	Gets or sets the ReferenceBeamRadius.
ReferenceXCoordinate	Gets or sets the ReferenceXCoordinate.
ReferenceYCoordinate	Gets or sets the ReferenceYCoordinate.
ReferenceZCoordinate	Gets or sets the ReferenceZCoordinate.
SpringLength	Gets the SpringLength.
LongitudinalDamping	Gets or sets the LongitudinalDamping.
MobilePinballRegion	Gets or sets the MobilePinballRegion.
FreeLength	Gets or sets the FreeLength.
Load	Gets or sets the Load.
Rotation	Gets or sets the Rotation.
Torque	Gets or sets the Torque.
ReferencePinballRegion	Gets or sets the ReferencePinballRegion.
TorsionalDamping	Gets or sets the TorsionalDamping.
TorsionalStiffness	Gets or sets the TorsionalStiffness.
MobileAppliedBy	Gets or sets the MobileAppliedBy.
ReferenceAppliedBy	Gets or sets the ReferenceAppliedBy.
SpringBehavior	Gets or sets the SpringBehavior.
MobileBehavior	Gets or sets the MobileBehavior.
PreloadType	Gets or sets the PreloadType.
ReferenceBehavior	Gets or sets the ReferenceBehavior.
Scope	Gets or sets the Scope.
SpringType	Gets or sets the SpringType.
Visible	Gets or sets the Visible.
Suppressed	Gets or sets the Suppressed.
MobileCoordinateSystem	Gets or sets the MobileCoordinateSystem.
ReferenceCoordinateSystem	Gets or sets the ReferenceCoordinateSystem.
MobileLocation	Gets or sets the MobileLocation.
MobileScopeLocation	Gets or sets the MobileScopeLocation.
ReferenceLocation	Gets or sets the ReferenceLocation.
ReferenceScopeLocation	Gets or sets the ReferenceScopeLocation.
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.
ReadOnly	Gets or sets the ReadOnly.
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 Spring.NonLinearLongitudinalStiffness: Ansys.ACT.Mechanical.Fields.Field | None

Gets the non linear longitudinal stiffness defined in the tabular data.

property Spring.LongitudinalStiffness: Ansys.Core.Units.Quantity | None

Gets or sets the constant longitudinal stiffness (expressed in N/m).

property Spring.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSSpringAuto | None

Gets the internal object. For advanced usage only.

property Spring.Material: System.String | None

Gets or sets the Material.

property Spring.MobileBeamMaterial: System.String | None

Gets or sets the MobileBeamMaterial.

property Spring.MobileBody: System.String | None

Gets the MobileBody.

property Spring.ReferenceBeamMaterial: System.String | None

Gets or sets the ReferenceBeamMaterial.

property Spring.ReferenceBody: System.String | None

Gets the ReferenceBody.

property Spring.SpringElementAPDLName: System.String | None

Gets or sets the SpringElementAPDLName.

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

Gets or sets the MobileBeamRadius.

property Spring.MobileXCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the MobileXCoordinate.

property Spring.MobileYCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the MobileYCoordinate.

property Spring.MobileZCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the MobileZCoordinate.

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

Gets or sets the ReferenceBeamRadius.

property Spring.ReferenceXCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceXCoordinate.

property Spring.ReferenceYCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceYCoordinate.

property Spring.ReferenceZCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceZCoordinate.

property Spring.SpringLength: Ansys.Core.Units.Quantity | None

Gets the SpringLength.

property Spring.LongitudinalDamping: Ansys.Core.Units.Quantity | None

Gets or sets the LongitudinalDamping.

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

Gets or sets the MobilePinballRegion.

property Spring.FreeLength: Ansys.Core.Units.Quantity | None

Gets or sets the FreeLength.

property Spring.Load: Ansys.Core.Units.Quantity | None

Gets or sets the Load.

property Spring.Rotation: Ansys.Core.Units.Quantity | None

Gets or sets the Rotation.

property Spring.Torque: Ansys.Core.Units.Quantity | None

Gets or sets the Torque.

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

Gets or sets the ReferencePinballRegion.

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

Gets or sets the TorsionalDamping.

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

Gets or sets the TorsionalStiffness.

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

Gets or sets the MobileAppliedBy.

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

Gets or sets the ReferenceAppliedBy.

property Spring.SpringBehavior: Ansys.Mechanical.DataModel.Enums.SpringBehavior | None

Gets or sets the SpringBehavior.

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

Gets or sets the MobileBehavior.

property Spring.PreloadType: Ansys.Mechanical.DataModel.Enums.SpringPreloadType | None

Gets or sets the PreloadType.

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

Gets or sets the ReferenceBehavior.

property Spring.Scope: Ansys.Mechanical.DataModel.Enums.SpringScopingType | None

Gets or sets the Scope.

property Spring.SpringType: Ansys.Mechanical.DataModel.Enums.SpringType | None

Gets or sets the SpringType.

property Spring.Visible: System.Boolean | None

Gets or sets the Visible.

property Spring.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

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

Gets or sets the MobileCoordinateSystem.

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

Gets or sets the ReferenceCoordinateSystem.

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

Gets or sets the MobileLocation.

property Spring.MobileScopeLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the MobileScopeLocation.

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

Gets or sets the ReferenceLocation.

property Spring.ReferenceScopeLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the ReferenceScopeLocation.

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

Gets the current DataModelObject’s category.

property Spring.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Spring.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Spring.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Spring.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Spring.ReadOnly: System.Boolean | None

Gets or sets the ReadOnly.

property Spring.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property Spring.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property Spring.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

Spring.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

Spring.PromoteToRemotePoint() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.RemotePoint]

Run the PromoteToRemotePoint action.

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

Creates a new CommandSnippet

Spring.RenameBasedOnDefinition() → System.Void

Run the RenameBasedOnDefinition action.

Spring.Delete() → System.Void

Run the Delete action.

Spring.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

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

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

Creates a new child Comment.

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

Creates a new child Figure.

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

Spring.Activate() → System.Void

Activate the current object.

Spring.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void

Copies all visible properties from this object to another.

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

Creates a copy of the current DataModelObject.

Spring.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Spring.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

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

Spring.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

Spring.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Spring.RemoveParameter(propName: System.String) → System.Void

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