RectangularCrossSection
Last update: 14.01.2025
RectangularCrossSection
class Ansys.ACT.Automation.Mechanical.RectangularCrossSection
Bases: object
Defines a RectangularCrossSection.
Overview
Methods
Name | Description |
---|---|
Activate |
Activate the current object. |
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. |
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. |
Properties
Name | Description |
---|---|
Area |
Gets the Area. |
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
Figures |
Gets the list of associated figures. |
Height |
Gets or sets the Height. |
IYY |
Gets the IYY. |
IZZ |
Gets the IZZ. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
Properties |
Gets the list of properties for this object. |
ReadOnly |
Gets or sets the ReadOnly. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Width |
Gets or sets the Width. |
Property detail
property RectangularCrossSection.Area : Ansys.Core.Units.Quantity | None
Gets the Area.
property RectangularCrossSection.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property RectangularCrossSection.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property RectangularCrossSection.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property RectangularCrossSection.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property RectangularCrossSection.Height : Ansys.Core.Units.Quantity | None
Gets or sets the Height.
property RectangularCrossSection.IYY : Ansys.Core.Units.Quantity | None
Gets the IYY.
property RectangularCrossSection.IZZ : Ansys.Core.Units.Quantity | None
Gets the IZZ.
property RectangularCrossSection.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property RectangularCrossSection.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSCrossSectionAuto | None
Gets the internal object. For advanced usage only.
property RectangularCrossSection.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property RectangularCrossSection.ReadOnly : bool | None
Gets or sets the ReadOnly.
property RectangularCrossSection.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
property RectangularCrossSection.Width : Ansys.Core.Units.Quantity | None
Gets or sets the Width.
Method detail
RectangularCrossSection.Activate()
Activate the current object.
RectangularCrossSection.AddComment()
Creates a new child Comment.
RectangularCrossSection.AddFigure()
Creates a new child Figure.
RectangularCrossSection.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.
RectangularCrossSection.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
RectangularCrossSection.CreateParameter(propName: str)
Creates a new parameter for a Property.
RectangularCrossSection.Delete()
Run the Delete action.
RectangularCrossSection.Duplicate()
Creates a copy of the current DataModelObject.
RectangularCrossSection.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
RectangularCrossSection.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
RectangularCrossSection.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
RectangularCrossSection.GroupSimilarObjects()
Run the GroupSimilarObjects action.
RectangularCrossSection.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.
RectangularCrossSection.PropertyByName(name: str)
Get a property by its unique name.
RectangularCrossSection.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.