`CrossSections`#

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

Bases: object

Defines a CrossSections.

Overview#

Methods

`Activate`	Activate the current object.
`AddChannelCrossSection`	Creates a new ChannelCrossSection
`AddCircularCrossSection`	Creates a new CircularCrossSection
`AddCircularTubeCrossSection`	Creates a new CircularTubeCrossSection
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddHatCrossSection`	Creates a new HatCrossSection
`AddHollowRectangularCrossSection`	Creates a new HollowRectangularCrossSection
`AddICrossSection`	Creates a new ICrossSection
`AddImage`	Creates a new child Image.
`AddLCrossSection`	Creates a new LCrossSection
`AddRectangularCrossSection`	Creates a new RectangularCrossSection
`AddTCrossSection`	Creates a new TCrossSection
`AddUserDefinedCrossSection`	Creates a new UserDefinedCrossSection
`AddZCrossSection`	Creates a new ZCrossSection
`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.
`NameCrossSectionsUniquely`	programmatically give each of the Cross Section objects a unique name .
`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

`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.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property CrossSections.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property CrossSections.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#: Gets the list of associated comments.

property CrossSections.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#: Gets the current DataModelObject's category.

property CrossSections.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

property CrossSections.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

property CrossSections.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSCrossSectionGroupAuto | None#: Gets the internal object. For advanced usage only.

property CrossSections.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property CrossSections.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

Method detail#

CrossSections.Activate() → None#: Activate the current object.

CrossSections.AddChannelCrossSection() → Ansys.ACT.Automation.Mechanical.ChannelCrossSection#: Creates a new ChannelCrossSection

CrossSections.AddCircularCrossSection() → Ansys.ACT.Automation.Mechanical.CircularCrossSection#: Creates a new CircularCrossSection

CrossSections.AddCircularTubeCrossSection() → Ansys.ACT.Automation.Mechanical.CircularTubeCrossSection#: Creates a new CircularTubeCrossSection

CrossSections.AddComment() → Ansys.ACT.Automation.Mechanical.Comment#: Creates a new child Comment.

CrossSections.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure#: Creates a new child Figure.

CrossSections.AddHatCrossSection() → Ansys.ACT.Automation.Mechanical.HatCrossSection#: Creates a new HatCrossSection

CrossSections.AddHollowRectangularCrossSection() → Ansys.ACT.Automation.Mechanical.HollowRectangularCrossSection#: Creates a new HollowRectangularCrossSection

CrossSections.AddICrossSection() → Ansys.ACT.Automation.Mechanical.ICrossSection#: Creates a new ICrossSection

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

CrossSections.AddLCrossSection() → Ansys.ACT.Automation.Mechanical.LCrossSection#: Creates a new LCrossSection

CrossSections.AddRectangularCrossSection() → Ansys.ACT.Automation.Mechanical.RectangularCrossSection#: Creates a new RectangularCrossSection

CrossSections.AddTCrossSection() → Ansys.ACT.Automation.Mechanical.TCrossSection#: Creates a new TCrossSection

CrossSections.AddUserDefinedCrossSection() → Ansys.ACT.Automation.Mechanical.UserDefinedCrossSection#: Creates a new UserDefinedCrossSection

CrossSections.AddZCrossSection() → Ansys.ACT.Automation.Mechanical.ZCrossSection#: Creates a new ZCrossSection

CrossSections.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None#: Copies all visible properties from this object to another.

CrossSections.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Creates a new parameter for a Property.

CrossSections.Delete() → None#: Run the Delete action.

CrossSections.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#: Creates a copy of the current DataModelObject.

CrossSections.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

CrossSections.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Gets the parameter corresponding to the given property.

CrossSections.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

CrossSections.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#: Run the GroupSimilarObjects action.

CrossSections.NameCrossSectionsUniquely() → None#: programmatically give each of the Cross Section objects a unique name .

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

CrossSections.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property#: Get a property by its unique name.

CrossSections.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.