.. 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:`~Activate` - Activate the current object. * - :py:attr:`~AddChannelCrossSection` - Creates a new ChannelCrossSection * - :py:attr:`~AddCircularCrossSection` - Creates a new CircularCrossSection * - :py:attr:`~AddCircularTubeCrossSection` - Creates a new CircularTubeCrossSection * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddHatCrossSection` - Creates a new HatCrossSection * - :py:attr:`~AddHollowRectangularCrossSection` - Creates a new HollowRectangularCrossSection * - :py:attr:`~AddICrossSection` - Creates a new ICrossSection * - :py:attr:`~AddImage` - Creates a new child Image. * - :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:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~NameCrossSectionsUniquely` - programmatically give each of the Cross Section objects a unique name . * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :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:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :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:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Figures :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: Images :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSCrossSectionGroupAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Properties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: AddChannelCrossSection() -> Ansys.ACT.Automation.Mechanical.ChannelCrossSection Creates a new ChannelCrossSection .. !! processed by numpydoc !! .. py:method:: AddCircularCrossSection() -> Ansys.ACT.Automation.Mechanical.CircularCrossSection Creates a new CircularCrossSection .. !! processed by numpydoc !! .. py:method:: AddCircularTubeCrossSection() -> Ansys.ACT.Automation.Mechanical.CircularTubeCrossSection Creates a new CircularTubeCrossSection .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddHatCrossSection() -> Ansys.ACT.Automation.Mechanical.HatCrossSection Creates a new HatCrossSection .. !! processed by numpydoc !! .. py:method:: AddHollowRectangularCrossSection() -> Ansys.ACT.Automation.Mechanical.HollowRectangularCrossSection Creates a new HollowRectangularCrossSection .. !! processed by numpydoc !! .. py:method:: AddICrossSection() -> Ansys.ACT.Automation.Mechanical.ICrossSection Creates a new ICrossSection .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: str) -> Ansys.ACT.Automation.Mechanical.Image .. 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:: AddLCrossSection() -> Ansys.ACT.Automation.Mechanical.LCrossSection Creates a new LCrossSection .. !! processed by numpydoc !! .. py:method:: AddRectangularCrossSection() -> Ansys.ACT.Automation.Mechanical.RectangularCrossSection Creates a new RectangularCrossSection .. !! processed by numpydoc !! .. py:method:: AddTCrossSection() -> Ansys.ACT.Automation.Mechanical.TCrossSection Creates a new TCrossSection .. !! processed by numpydoc !! .. py:method:: AddUserDefinedCrossSection() -> Ansys.ACT.Automation.Mechanical.UserDefinedCrossSection Creates a new UserDefinedCrossSection .. !! processed by numpydoc !! .. py:method:: AddZCrossSection() -> Ansys.ACT.Automation.Mechanical.ZCrossSection Creates a new ZCrossSection .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> None Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: Delete() -> None Run the Delete action. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: bool, children: List[ChildrenType]) -> List[ChildrenType] Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> None Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: NameCrossSectionsUniquely() -> None programmatically give each of the Cross Section objects a unique name . .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: str) -> Ansys.ACT.Automation.Mechanical.Property .. 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:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on