Beam
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Connections.Beam#
Bases:
object
Defines a Beam.
Overview#
|
Run the PromoteToNamedSelection action. |
|
Run the PromoteToRemotePoint action. |
|
Creates a new CommandSnippet |
|
Run the RenameBasedOnDefinition action. |
|
Run the Delete action. |
|
Gets the list of children, filtered by type. |
|
Gets the list of children, filtered by type. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Activate the current object. |
|
Copies all visible properties from this object to another. |
|
Creates a copy of the current DataModelObject. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its unique name. |
|
Get a property by its API name. |
|
Creates a new parameter for a Property. |
|
Gets the parameter corresponding to the given property. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Gets the internal object. For advanced usage only. |
|
Gets or sets the BeamElementAPDLName. |
|
Gets or sets the Material. |
|
Gets or sets the MobileBeamMaterial. |
|
Gets the MobileBody. |
|
Gets or sets the ReferenceBeamMaterial. |
|
Gets the ReferenceBody. |
|
Gets or sets the MobileBeamRadius. |
|
Gets or sets the MobileXCoordinate. |
|
Gets or sets the MobileYCoordinate. |
|
Gets or sets the MobileZCoordinate. |
|
Gets or sets the MobilePinballRegion. |
|
Gets or sets the Radius. |
|
Gets or sets the ReferenceBeamRadius. |
|
Gets or sets the ReferenceXCoordinate. |
|
Gets or sets the ReferenceYCoordinate. |
|
Gets or sets the ReferenceZCoordinate. |
|
Gets or sets the ReferencePinballRegion. |
|
Gets the CrossSection. |
|
Gets or sets the MobileAppliedBy. |
|
Gets or sets the MobileBehavior. |
|
Gets or sets the ReferenceAppliedBy. |
|
Gets or sets the ReferenceBehavior. |
|
Gets or sets the Scope. |
|
Gets or sets the Visible. |
|
Gets or sets the Suppressed. |
|
Gets or sets the MobileCoordinateSystem. |
|
Gets or sets the ReferenceCoordinateSystem. |
|
Gets or sets the MobileLocation. |
|
Gets or sets the ReferenceLocationPoint. |
|
Gets or sets the ReferenceLocation. |
|
Gets the current DataModelObject’s category. |
|
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets the list of associated figures. |
|
Gets the list of associated images. |
|
Gets or sets the ReadOnly. |
|
Gets the internal object. For advanced usage only. |
|
Gets the list of properties for this object. |
|
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.