.. vale off :class:`RemotePoint` ==================== .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.RemotePoint Bases: :py:obj:`object` Defines a RemotePoint. .. !! processed by numpydoc !! .. py:currentmodule:: RemotePoint Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~GetMeshRegion` - Returns the mesh region associated to the remote point. * - :py:attr:`~PromoteToNamedSelection` - Run the PromoteToNamedSelection action. * - :py:attr:`~AddCommandSnippet` - Creates a new CommandSnippet * - :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:`~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:`~PilotNodeAPDLName` - Gets or sets the PilotNodeAPDLName. * - :py:attr:`~OutlineSelection` - Gets or sets the OutlineSelection. * - :py:attr:`~GloballyAvailable` - Remote point is globally available * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Material` - Gets or sets the Material. * - :py:attr:`~Radius` - Gets or sets the Radius. * - :py:attr:`~XCoordinate` - Gets or sets the XCoordinate. * - :py:attr:`~YCoordinate` - Gets or sets the YCoordinate. * - :py:attr:`~ZCoordinate` - Gets or sets the ZCoordinate. * - :py:attr:`~PinballRegion` - Gets or sets the PinballRegion. * - :py:attr:`~Behavior` - Gets or sets the Behavior. * - :py:attr:`~XComponent` - Gets or sets the XComponent. * - :py:attr:`~YComponent` - Gets or sets the YComponent. * - :py:attr:`~ZComponent` - Gets or sets the ZComponent. * - :py:attr:`~DOFSelection` - Gets or sets the DOFSelection. * - :py:attr:`~ScopingMethod` - Gets or sets the ScopingMethod. * - :py:attr:`~PilotNodeScopingType` - Gets or sets the PilotNodeScopingType. * - :py:attr:`~Formulation` - Gets or sets the Formulation. * - :py:attr:`~RotationX` - Gets or sets the RotationX. * - :py:attr:`~RotationY` - Gets or sets the RotationY. * - :py:attr:`~RotationZ` - Gets or sets the RotationZ. * - :py:attr:`~RelaxationMethod` - Gets or sets the RelaxationMethod. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~Point` - Gets or sets the Point. * - :py:attr:`~CoordinateSystem` - Gets or sets the CoordinateSystem. * - :py:attr:`~Location` - Gets or sets the Location. * - :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:`~ReadOnly` - Gets or sets the ReadOnly. * - :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:: PilotNodeAPDLName :no-index: :type: Optional[System.String] Gets or sets the PilotNodeAPDLName. .. !! processed by numpydoc !! .. py:property:: OutlineSelection :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.RemotePoint]] Gets or sets the OutlineSelection. .. !! processed by numpydoc !! .. py:property:: GloballyAvailable :no-index: :type: Optional[System.Boolean] Remote point is globally available .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSRemotePointAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Material :no-index: :type: Optional[System.String] Gets or sets the Material. .. !! processed by numpydoc !! .. py:property:: Radius :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the Radius. .. !! processed by numpydoc !! .. py:property:: XCoordinate :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the XCoordinate. .. !! processed by numpydoc !! .. py:property:: YCoordinate :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the YCoordinate. .. !! processed by numpydoc !! .. py:property:: ZCoordinate :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ZCoordinate. .. !! processed by numpydoc !! .. py:property:: PinballRegion :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the PinballRegion. .. !! processed by numpydoc !! .. py:property:: Behavior :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.LoadBehavior] Gets or sets the Behavior. .. !! processed by numpydoc !! .. py:property:: XComponent :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the XComponent. .. !! processed by numpydoc !! .. py:property:: YComponent :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the YComponent. .. !! processed by numpydoc !! .. py:property:: ZComponent :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the ZComponent. .. !! processed by numpydoc !! .. py:property:: DOFSelection :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.RemotePointDOFSelectionType] Gets or sets the DOFSelection. .. !! processed by numpydoc !! .. py:property:: ScopingMethod :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the ScopingMethod. .. !! processed by numpydoc !! .. py:property:: PilotNodeScopingType :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.PilotNodeScopingType] Gets or sets the PilotNodeScopingType. .. !! processed by numpydoc !! .. py:property:: Formulation :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.RemotePointFormulation] Gets or sets the Formulation. .. !! processed by numpydoc !! .. py:property:: RotationX :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the RotationX. .. !! processed by numpydoc !! .. py:property:: RotationY :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the RotationY. .. !! processed by numpydoc !! .. py:property:: RotationZ :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the RotationZ. .. !! processed by numpydoc !! .. py:property:: RelaxationMethod :no-index: :type: Optional[System.Boolean] Gets or sets the RelaxationMethod. .. !! processed by numpydoc !! .. py:property:: Suppressed :no-index: :type: Optional[System.Boolean] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: Point :no-index: :type: Optional[Ansys.ACT.Automation.Mechanical.ConstructionPoint] Gets or sets the Point. .. !! processed by numpydoc !! .. py:property:: CoordinateSystem :no-index: :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the CoordinateSystem. .. !! processed by numpydoc !! .. py:property:: Location :no-index: :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! 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:: ReadOnly :no-index: :type: Optional[System.Boolean] Gets or sets the ReadOnly. .. !! 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:: GetMeshRegion() -> Ansys.ACT.Interfaces.Mesh.IMeshRegion :no-index: Returns the mesh region associated to the remote point. .. !! processed by numpydoc !! .. py:method:: PromoteToNamedSelection() -> System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection] :no-index: Run the PromoteToNamedSelection action. .. !! processed by numpydoc !! .. py:method:: AddCommandSnippet() -> Ansys.ACT.Automation.Mechanical.CommandSnippet :no-index: Creates a new CommandSnippet .. !! 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:: 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