.. vale off :class:`CrossSections` ====================== .. py:class:: ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.CrossSections Bases: :py:obj:`object` Defines a CrossSections. .. !! processed by numpydoc !! .. py:currentmodule:: CrossSections Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~NameCrossSectionsUniquely` - programmatically give each of the Cross Section objects a unique name . * - :py:attr:`~AddChannelCrossSection` - Creates a new ChannelCrossSection * - :py:attr:`~AddCircularCrossSection` - Creates a new CircularCrossSection * - :py:attr:`~AddCircularTubeCrossSection` - Creates a new CircularTubeCrossSection * - :py:attr:`~AddHatCrossSection` - Creates a new HatCrossSection * - :py:attr:`~AddHollowRectangularCrossSection` - Creates a new HollowRectangularCrossSection * - :py:attr:`~AddICrossSection` - Creates a new ICrossSection * - :py:attr:`~AddLCrossSection` - Creates a new LCrossSection * - :py:attr:`~AddRectangularCrossSection` - Creates a new RectangularCrossSection * - :py:attr:`~AddTCrossSection` - Creates a new TCrossSection * - :py:attr:`~AddUserDefinedCrossSection` - Creates a new UserDefinedCrossSection * - :py:attr:`~AddZCrossSection` - Creates a new ZCrossSection * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSCrossSectionGroupAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Children :no-index: :type: Optional[System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: Figures :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: Images :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[System.Object] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Properties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: NameCrossSectionsUniquely() -> System.Void :no-index: programmatically give each of the Cross Section objects a unique name . .. !! processed by numpydoc !! .. py:method:: AddChannelCrossSection() -> Ansys.ACT.Automation.Mechanical.ChannelCrossSection :no-index: Creates a new ChannelCrossSection .. !! processed by numpydoc !! .. py:method:: AddCircularCrossSection() -> Ansys.ACT.Automation.Mechanical.CircularCrossSection :no-index: Creates a new CircularCrossSection .. !! processed by numpydoc !! .. py:method:: AddCircularTubeCrossSection() -> Ansys.ACT.Automation.Mechanical.CircularTubeCrossSection :no-index: Creates a new CircularTubeCrossSection .. !! processed by numpydoc !! .. py:method:: AddHatCrossSection() -> Ansys.ACT.Automation.Mechanical.HatCrossSection :no-index: Creates a new HatCrossSection .. !! processed by numpydoc !! .. py:method:: AddHollowRectangularCrossSection() -> Ansys.ACT.Automation.Mechanical.HollowRectangularCrossSection :no-index: Creates a new HollowRectangularCrossSection .. !! processed by numpydoc !! .. py:method:: AddICrossSection() -> Ansys.ACT.Automation.Mechanical.ICrossSection :no-index: Creates a new ICrossSection .. !! processed by numpydoc !! .. py:method:: AddLCrossSection() -> Ansys.ACT.Automation.Mechanical.LCrossSection :no-index: Creates a new LCrossSection .. !! processed by numpydoc !! .. py:method:: AddRectangularCrossSection() -> Ansys.ACT.Automation.Mechanical.RectangularCrossSection :no-index: Creates a new RectangularCrossSection .. !! processed by numpydoc !! .. py:method:: AddTCrossSection() -> Ansys.ACT.Automation.Mechanical.TCrossSection :no-index: Creates a new TCrossSection .. !! processed by numpydoc !! .. py:method:: AddUserDefinedCrossSection() -> Ansys.ACT.Automation.Mechanical.UserDefinedCrossSection :no-index: Creates a new UserDefinedCrossSection .. !! processed by numpydoc !! .. py:method:: AddZCrossSection() -> Ansys.ACT.Automation.Mechanical.ZCrossSection :no-index: Creates a new ZCrossSection .. !! processed by numpydoc !! .. py:method:: Delete() -> System.Void :no-index: Run the Delete action. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) -> System.Collections.Generic.IList[ChildrenType] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) -> System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment :no-index: Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure :no-index: Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: System.String) -> Ansys.ACT.Automation.Mechanical.Image :no-index: .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: Activate() -> System.Void :no-index: Activate the current object. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> System.Void :no-index: Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject :no-index: Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> System.Void :no-index: Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder :no-index: Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: System.String) -> System.Void :no-index: Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on