Skip to main content

Mechanical scripting interface

ICrossSection

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ICrossSection

Bases: object

Defines a ICrossSection.

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.
InternalObject Gets the internal object. For advanced usage only.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
Thick1 Gets or sets the Thick1.
Thick2 Gets or sets the Thick2.
Thick3 Gets or sets the Thick3.
VisibleProperties Gets the list of properties that are visible for this object.
Width1 Gets or sets the Width1.
Width2 Gets or sets the Width2.
Width3 Gets or sets the Width3.

Property detail

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

Gets the Area.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the IYY.

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

Gets the IZZ.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property ICrossSection.ReadOnly : bool | None

Gets or sets the ReadOnly.

property ICrossSection.Thick1 : Ansys.Core.Units.Quantity | None

Gets or sets the Thick1.

property ICrossSection.Thick2 : Ansys.Core.Units.Quantity | None

Gets or sets the Thick2.

property ICrossSection.Thick3 : Ansys.Core.Units.Quantity | None

Gets or sets the Thick3.

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

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

property ICrossSection.Width1 : Ansys.Core.Units.Quantity | None

Gets or sets the Width1.

property ICrossSection.Width2 : Ansys.Core.Units.Quantity | None

Gets or sets the Width2.

property ICrossSection.Width3 : Ansys.Core.Units.Quantity | None

Gets or sets the Width3.

Method detail

ICrossSection.Activate()

Activate the current object.

ICrossSection.AddComment()

Creates a new child Comment.

ICrossSection.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

ICrossSection.CreateParameter(propName: str)

Creates a new parameter for a Property.

ICrossSection.Delete()

Run the Delete action.

ICrossSection.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

ICrossSection.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ICrossSection.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ICrossSection.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ICrossSection.PropertyByName(name: str)

Get a property by its unique name.

ICrossSection.RemoveParameter(propName: str)

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