Beam

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

Bases: object

Defines a Beam.

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.
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.
BeamElementAPDLName	Gets or sets the BeamElementAPDLName.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
CrossSection	Gets the CrossSection.
DataModelObjectCategory	Gets the current DataModelObject's category.
Figures	Gets the list of associated figures.
GloballyAvailable	Gets or sets the GloballyAvailable.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
Material	Gets or sets the Material.
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.
MobileLocation	Gets or sets the MobileLocation.
MobileNodeId	Returns Mobile Node Id.
MobilePinballRegion	Gets or sets the MobilePinballRegion.
MobileXCoordinate	Gets or sets the MobileXCoordinate.
MobileYCoordinate	Gets or sets the MobileYCoordinate.
MobileZCoordinate	Gets or sets the MobileZCoordinate.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
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.
ReferenceLocation	Gets or sets the ReferenceLocation.
ReferenceLocationPoint	Gets or sets the ReferenceLocationPoint.
ReferenceNodeId	Returns Reference Node Id.
ReferencePinballRegion	Gets or sets the ReferencePinballRegion.
ReferenceXCoordinate	Gets or sets the ReferenceXCoordinate.
ReferenceYCoordinate	Gets or sets the ReferenceYCoordinate.
ReferenceZCoordinate	Gets or sets the ReferenceZCoordinate.
Scope	Gets or sets the Scope.
State	State property.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
Visible	Gets or sets the Visible.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property Beam.AttachedRefs: List[int] | None

AttachedRefs property.

property Beam.BeamElementAPDLName: str | None

Gets or sets the BeamElementAPDLName.

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

Gets the list of children.

property Beam.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property Beam.CrossSection: Ansys.Mechanical.DataModel.Enums.CrossSectionType | None

Gets the CrossSection.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property Beam.GloballyAvailable: bool | None

Gets or sets the GloballyAvailable.

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

GroupingFolder property.

property Beam.IconName: str | None

IconName property.

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

Gets the list of associated images.

property Beam.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property Beam.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSBeamConnectionAuto | None

Gets the internal object. For advanced usage only.

property Beam.Material: str | None

Gets or sets the Material.

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

Gets or sets the MobileAppliedBy.

property Beam.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 Beam.MobileBeamMaterial: str | None

Gets or sets the MobileBeamMaterial.

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

Gets or sets the MobileBeamRadius.

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

Gets or sets the MobileBehavior.

property Beam.MobileBody: str | None

Gets the MobileBody.

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

Gets or sets the MobileCoordinateSystem.

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

Gets or sets the MobileLocation.

property Beam.MobileNodeId: int | None

Returns Mobile Node Id.

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

Gets or sets the MobilePinballRegion.

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

Gets or sets the MobileXCoordinate.

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

Gets or sets the MobileYCoordinate.

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

Gets or sets the MobileZCoordinate.

property Beam.Name: str | None

Name property.

property Beam.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

Gets the list of properties for this object.

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

Gets or sets the Radius.

property Beam.ReadOnly: bool | None

Gets or sets the ReadOnly.

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

Gets or sets the ReferenceAppliedBy.

property Beam.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 Beam.ReferenceBeamMaterial: str | None

Gets or sets the ReferenceBeamMaterial.

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

Gets or sets the ReferenceBeamRadius.

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

Gets or sets the ReferenceBehavior.

property Beam.ReferenceBody: str | None

Gets the ReferenceBody.

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

Gets or sets the ReferenceCoordinateSystem.

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

Gets or sets the ReferenceLocation.

property Beam.ReferenceLocationPoint: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the ReferenceLocationPoint.

property Beam.ReferenceNodeId: int | None

Returns Reference Node Id.

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

Gets or sets the ReferencePinballRegion.

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

Gets or sets the ReferenceXCoordinate.

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

Gets or sets the ReferenceYCoordinate.

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

Gets or sets the ReferenceZCoordinate.

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

Gets or sets the Scope.

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

State property.

property Beam.Suppressed: bool | None

Gets or sets the Suppressed.

property Beam.TransferableObjectId: str | None

TransferableObjectId property.

property Beam.Visible: bool | None

Gets or sets the Visible.

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

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

Method detail

Beam.Activate() → None

Activate the current object.

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

Creates a new CommandSnippet

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

Beam.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

Beam.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

Beam.GetHashCode() → int

GetHashCode method.

Beam.GetIconFile() → System.Byte

GetIconFile method.

Beam.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

Beam.GetPath() → str

GetPath method.

Beam.GetPropertyName(dispId: int) → str

GetPropertyName method.

Beam.GetPropertyValue(name: str) → Any

GetPropertyValue method.

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

GetTableGenerator method.

Beam.GetType() → type

GetType method.

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

GetVisibleProperties method.

Beam.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

Beam.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Beam.InitializeLifetimeService() → Any

InitializeLifetimeService method.

Beam.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

Beam.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

Run the PromoteToNamedSelection action.

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

Run the PromoteToRemotePoint action.

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

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

PropertyById method.

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

Get a property by its unique name.

Beam.RemoveParameter(propName: str) → None

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

Beam.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

Beam.ToString() → str

ToString method.