UserDefinedCrossSection#

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

Bases: object

Defines a UserDefinedCrossSection.

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 or sets the Area.

CGZ

Gets or sets the CGZ.

CGy

Gets or sets the CGy.

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.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

Iw

Gets or sets the Iw.

Iyy

Gets or sets the Iyy.

Izz

Gets or sets the Izz.

J

Gets or sets the J.

Properties

Gets the list of properties for this object.

ReadOnly

Gets or sets the ReadOnly.

SHy

Gets or sets the SHy.

SHz

Gets or sets the SHz.

VisibleProperties

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

Property detail#

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

Gets or sets the Area.

property UserDefinedCrossSection.CGZ: Ansys.Core.Units.Quantity | None#

Gets or sets the CGZ.

property UserDefinedCrossSection.CGy: Ansys.Core.Units.Quantity | None#

Gets or sets the CGy.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property UserDefinedCrossSection.Iw: Ansys.Core.Units.Quantity | None#

Gets or sets the Iw.

property UserDefinedCrossSection.Iyy: Ansys.Core.Units.Quantity | None#

Gets or sets the Iyy.

property UserDefinedCrossSection.Izz: Ansys.Core.Units.Quantity | None#

Gets or sets the Izz.

property UserDefinedCrossSection.J: Ansys.Core.Units.Quantity | None#

Gets or sets the J.

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

Gets the list of properties for this object.

property UserDefinedCrossSection.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property UserDefinedCrossSection.SHy: Ansys.Core.Units.Quantity | None#

Gets or sets the SHy.

property UserDefinedCrossSection.SHz: Ansys.Core.Units.Quantity | None#

Gets or sets the SHz.

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

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

Method detail#

UserDefinedCrossSection.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

UserDefinedCrossSection.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

UserDefinedCrossSection.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Get a property by its unique name.

UserDefinedCrossSection.RemoveParameter(propName: str) None#

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