Beam

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

Bases: object

Defines a Beam.

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

InternalObject	Gets the internal object. For advanced usage only.
BeamElementAPDLName	Gets or sets the BeamElementAPDLName.
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.
MobileBeamRadius	Gets or sets the MobileBeamRadius.
MobileXCoordinate	Gets or sets the MobileXCoordinate.
MobileYCoordinate	Gets or sets the MobileYCoordinate.
MobileZCoordinate	Gets or sets the MobileZCoordinate.
MobilePinballRegion	Gets or sets the MobilePinballRegion.
Radius	Gets or sets the Radius.
ReferenceBeamRadius	Gets or sets the ReferenceBeamRadius.
ReferenceXCoordinate	Gets or sets the ReferenceXCoordinate.
ReferenceYCoordinate	Gets or sets the ReferenceYCoordinate.
ReferenceZCoordinate	Gets or sets the ReferenceZCoordinate.
ReferencePinballRegion	Gets or sets the ReferencePinballRegion.
CrossSection	Gets the CrossSection.
MobileAppliedBy	Gets or sets the MobileAppliedBy.
MobileBehavior	Gets or sets the MobileBehavior.
ReferenceAppliedBy	Gets or sets the ReferenceAppliedBy.
ReferenceBehavior	Gets or sets the ReferenceBehavior.
Scope	Gets or sets the Scope.
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.
ReferenceLocationPoint	Gets or sets the ReferenceLocationPoint.
ReferenceLocation	Gets or sets the ReferenceLocation.
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 Beam.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSBeamConnectionAuto | None

Gets the internal object. For advanced usage only.

property Beam.BeamElementAPDLName: System.String | None

Gets or sets the BeamElementAPDLName.

property Beam.Material: System.String | None

Gets or sets the Material.

property Beam.MobileBeamMaterial: System.String | None

Gets or sets the MobileBeamMaterial.

property Beam.MobileBody: System.String | None

Gets the MobileBody.

property Beam.ReferenceBeamMaterial: System.String | None

Gets or sets the ReferenceBeamMaterial.

property Beam.ReferenceBody: System.String | None

Gets the ReferenceBody.

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

Gets or sets the MobileBeamRadius.

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.MobilePinballRegion: Ansys.Core.Units.Quantity | None

Gets or sets the MobilePinballRegion.

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

Gets or sets the Radius.

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

Gets or sets the ReferenceBeamRadius.

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.ReferencePinballRegion: Ansys.Core.Units.Quantity | None

Gets or sets the ReferencePinballRegion.

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

Gets the CrossSection.

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

Gets or sets the MobileAppliedBy.

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

Gets or sets the MobileBehavior.

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

Gets or sets the ReferenceAppliedBy.

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

Gets or sets the ReferenceBehavior.

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

Gets or sets the Scope.

property Beam.Visible: System.Boolean | None

Gets or sets the Visible.

property Beam.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

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

Gets or sets the MobileCoordinateSystem.

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

Gets or sets the ReferenceCoordinateSystem.

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

Gets or sets the MobileLocation.

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

Gets or sets the ReferenceLocationPoint.

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

Gets or sets the ReferenceLocation.

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

Gets the current DataModelObject’s category.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property Beam.ReadOnly: System.Boolean | None

Gets or sets the ReadOnly.

property Beam.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

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

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

Method detail

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

Run the PromoteToNamedSelection action.

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

Run the PromoteToRemotePoint action.

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

Creates a new CommandSnippet

Beam.RenameBasedOnDefinition() → System.Void

Run the RenameBasedOnDefinition action.

Beam.Delete() → System.Void

Run the Delete action.

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

Gets the list of children, filtered by type.

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

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

Beam.Activate() → System.Void

Activate the current object.

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

Copies all visible properties from this object to another.

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

Creates a copy of the current DataModelObject.

Beam.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Get a property by its unique name.

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

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

Creates a new parameter for a Property.

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

Gets the parameter corresponding to the given property.

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

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