.. vale off :class:`MeshConnectionBase` =========================== .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.MeshConnectionBase Bases: :py:obj:`object` Defines a MeshConnectionBase. .. !! processed by numpydoc !! .. py:currentmodule:: MeshConnectionBase Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Activate` - Activate the current object. * - :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:`~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:`~Generate` - Run the Generate action. * - :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:`~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. * - :py:attr:`~RenameBasedOnDefinition` - Run the RenameBasedOnDefinition action. .. 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:`~MasterBodies` - Gets the MasterBodies. * - :py:attr:`~MasterLocation` - Gets or sets the MasterLocation. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~ScopeMode` - Gets the ScopeMode. * - :py:attr:`~ScopingMethod` - ScopingMethod property. * - :py:attr:`~SlaveBodies` - Gets the SlaveBodies. * - :py:attr:`~SlaveLocation` - Gets or sets the SlaveLocation. * - :py:attr:`~SnapToBoundary` - Gets or sets the SnapToBoundary. * - :py:attr:`~SnapTolerance` - Gets or sets the SnapTolerance. * - :py:attr:`~SnapType` - Gets or sets the SnapType. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~ToleranceSlider` - Gets or sets the ToleranceSlider. * - :py:attr:`~ToleranceType` - Gets or sets the ToleranceType. * - :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.IDSMeshConnectionAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: MasterBodies :type: Optional[str] Gets the MasterBodies. .. !! processed by numpydoc !! .. py:property:: MasterLocation :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the MasterLocation. .. !! 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:: ScopeMode :type: Optional[Ansys.Mechanical.DataModel.Enums.AutomaticOrManual] Gets the ScopeMode. .. !! processed by numpydoc !! .. py:property:: ScopingMethod :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] ScopingMethod property. .. !! processed by numpydoc !! .. py:property:: SlaveBodies :type: Optional[str] Gets the SlaveBodies. .. !! processed by numpydoc !! .. py:property:: SlaveLocation :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the SlaveLocation. .. !! processed by numpydoc !! .. py:property:: SnapToBoundary :type: Optional[bool] Gets or sets the SnapToBoundary. .. !! processed by numpydoc !! .. py:property:: SnapTolerance :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the SnapTolerance. .. !! processed by numpydoc !! .. py:property:: SnapType :type: Optional[Ansys.Mechanical.DataModel.Enums.SnapType] Gets or sets the SnapType. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[bool] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: ToleranceSlider :type: Optional[int] Gets or sets the ToleranceSlider. .. !! processed by numpydoc !! .. py:property:: ToleranceType :type: Optional[Ansys.Mechanical.DataModel.Enums.ContactToleranceType] Gets or sets the ToleranceType. .. !! 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:: 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:: 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:: 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:: Generate() -> None Run the Generate action. .. !! 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:: 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 !! .. py:method:: RenameBasedOnDefinition() -> None Run the RenameBasedOnDefinition action. .. !! processed by numpydoc !! .. vale on