ChannelCrossSection#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.ChannelCrossSection#

Bases: object

Defines a ChannelCrossSection.

Overview#

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.

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 ChannelCrossSection.Area: Ansys.Core.Units.Quantity | None#

Gets the Area.

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

Gets the list of children.

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

Gets the list of associated comments.

property ChannelCrossSection.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property ChannelCrossSection.IYY: Ansys.Core.Units.Quantity | None#

Gets the IYY.

property ChannelCrossSection.IZZ: Ansys.Core.Units.Quantity | None#

Gets the IZZ.

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

Gets the list of associated images.

property ChannelCrossSection.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSCrossSectionAuto | None#

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property ChannelCrossSection.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property ChannelCrossSection.Thick1: Ansys.Core.Units.Quantity | None#

Gets or sets the Thick1.

property ChannelCrossSection.Thick2: Ansys.Core.Units.Quantity | None#

Gets or sets the Thick2.

property ChannelCrossSection.Thick3: Ansys.Core.Units.Quantity | None#

Gets or sets the Thick3.

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

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

property ChannelCrossSection.Width1: Ansys.Core.Units.Quantity | None#

Gets or sets the Width1.

property ChannelCrossSection.Width2: Ansys.Core.Units.Quantity | None#

Gets or sets the Width2.

property ChannelCrossSection.Width3: Ansys.Core.Units.Quantity | None#

Gets or sets the Width3.

Method detail#

ChannelCrossSection.Activate() None#

Activate the current object.

ChannelCrossSection.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

ChannelCrossSection.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

ChannelCrossSection.AddImage(filePath: str) 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.
ChannelCrossSection.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

ChannelCrossSection.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

ChannelCrossSection.Delete() None#

Run the Delete action.

ChannelCrossSection.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

ChannelCrossSection.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

ChannelCrossSection.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

ChannelCrossSection.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

ChannelCrossSection.PropertyByAPIName(name: str) 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.
ChannelCrossSection.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

ChannelCrossSection.RemoveParameter(propName: str) None#

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