HatCrossSection#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.HatCrossSection#

Bases: object

Defines a HatCrossSection.

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.

Thick4

Gets or sets the Thick4.

Thick5

Gets or sets the Thick5.

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.

Width4

Gets or sets the Width4.

Property detail#

property HatCrossSection.Area: Ansys.Core.Units.Quantity | None#

Gets the Area.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

Gets the IYY.

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

Gets the IZZ.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property HatCrossSection.ReadOnly: bool | None#

Gets or sets the ReadOnly.

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

Gets or sets the Thick1.

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

Gets or sets the Thick2.

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

Gets or sets the Thick3.

property HatCrossSection.Thick4: Ansys.Core.Units.Quantity | None#

Gets or sets the Thick4.

property HatCrossSection.Thick5: Ansys.Core.Units.Quantity | None#

Gets or sets the Thick5.

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

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

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

Gets or sets the Width1.

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

Gets or sets the Width2.

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

Gets or sets the Width3.

property HatCrossSection.Width4: Ansys.Core.Units.Quantity | None#

Gets or sets the Width4.

Method detail#

HatCrossSection.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

HatCrossSection.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

HatCrossSection.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Get a property by its unique name.

HatCrossSection.RemoveParameter(propName: str) None#

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