Skip to main content

Mechanical scripting interface

CircularTubeCrossSection

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.CircularTubeCrossSection

Bases: object

Defines a CircularTubeCrossSection.

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.
IYY Gets the IYY.
IZZ Gets the IZZ.
Images Gets the list of associated images.
InnerRadius Gets or sets the InnerRadius.
InternalObject Gets the internal object. For advanced usage only.
OuterRadius Gets or sets the OuterRadius.
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.

Property detail

property CircularTubeCrossSection.Area : Ansys.Core.Units.Quantity | None

Gets the Area.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

property CircularTubeCrossSection.IYY : Ansys.Core.Units.Quantity | None

Gets the IYY.

property CircularTubeCrossSection.IZZ : Ansys.Core.Units.Quantity | None

Gets the IZZ.

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

Gets the list of associated images.

property CircularTubeCrossSection.InnerRadius : Ansys.Core.Units.Quantity | None

Gets or sets the InnerRadius.

property CircularTubeCrossSection.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSCrossSectionAuto | None

Gets the internal object. For advanced usage only.

property CircularTubeCrossSection.OuterRadius : Ansys.Core.Units.Quantity | None

Gets or sets the OuterRadius.

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

Gets the list of properties for this object.

property CircularTubeCrossSection.ReadOnly : bool | None

Gets or sets the ReadOnly.

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

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

Method detail

CircularTubeCrossSection.Activate()

Activate the current object.

CircularTubeCrossSection.AddComment()

Creates a new child Comment.

CircularTubeCrossSection.AddFigure()

Creates a new child Figure.

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

CircularTubeCrossSection.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

CircularTubeCrossSection.CreateParameter(propName: str)

Creates a new parameter for a Property.

CircularTubeCrossSection.Delete()

Run the Delete action.

CircularTubeCrossSection.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

CircularTubeCrossSection.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

CircularTubeCrossSection.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

CircularTubeCrossSection.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

CircularTubeCrossSection.PropertyByName(name: str)

Get a property by its unique name.

CircularTubeCrossSection.RemoveParameter(propName: str)

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