Beam
Last update: 14.01.2025
Beam
class Ansys.ACT.Automation.Mechanical.Connections.Beam
Bases: object
Defines a Beam.
Overview
Methods
Name | Description |
---|---|
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. |
CreateParameter |
Creates a new parameter for a Property. |
Delete |
Run the Delete action. |
Duplicate |
Creates a copy of the current DataModelObject. |
GetChildren |
Gets the list of children, filtered by type. |
GetParameter |
Gets the parameter corresponding to the given property. |
GroupAllSimilarChildren |
Run the GroupAllSimilarChildren action. |
GroupSimilarObjects |
Run the GroupSimilarObjects action. |
PromoteToNamedSelection |
Run the PromoteToNamedSelection action. |
PromoteToRemotePoint |
Run the PromoteToRemotePoint action. |
PropertyByAPIName |
Get a property by its API name. |
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. |
Properties
Name | Description |
---|---|
BeamElementAPDLName |
Gets or sets the BeamElementAPDLName. |
Children |
Gets the list of children. |
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. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
Material |
Gets or sets the Material. |
MobileAppliedBy |
Gets or sets the MobileAppliedBy. |
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. |
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. |
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. |
Suppressed |
Gets or sets the Suppressed. |
Visible |
Gets or sets the Visible. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
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.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.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
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.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.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.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.Suppressed : bool | None
Gets or sets the Suppressed.
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()
Activate the current object.
Beam.AddCommandSnippet()
Creates a new CommandSnippet
Beam.AddComment()
Creates a new child Comment.
Beam.AddFigure()
Creates a new child Figure.
Beam.AddImage(filePath: str)
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)
Copies all visible properties from this object to another.
Beam.CreateParameter(propName: str)
Creates a new parameter for a Property.
Beam.Delete()
Run the Delete action.
Beam.Duplicate()
Creates a copy of the current DataModelObject.
Beam.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
Beam.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
Beam.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
Beam.GroupSimilarObjects()
Run the GroupSimilarObjects action.
Beam.PromoteToNamedSelection()
Run the PromoteToNamedSelection action.
Beam.PromoteToRemotePoint()
Run the PromoteToRemotePoint action.
Beam.PropertyByAPIName(name: str)
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.PropertyByName(name: str)
Get a property by its unique name.
Beam.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.
Beam.RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.