.. 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:`~Activate` - Activate the current object. * - :py:attr:`~AddCommandSnippet` - Creates a new CommandSnippet * - :py:attr:`~AddComment` - Creates a new child Comment. * - :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:`~GetMeshRegion` - Returns the mesh region associated to the remote point. * - :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:`~PromoteToNamedSelection` - Run the PromoteToNamedSelection 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. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Behavior` - Gets or sets the Behavior. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~CoordinateSystem` - Gets or sets the CoordinateSystem. * - :py:attr:`~DOFSelection` - Gets or sets the DOFSelection. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Formulation` - Gets or sets the Formulation. * - :py:attr:`~GloballyAvailable` - Remote point is globally available * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Location` - Gets or sets the Location. * - :py:attr:`~Material` - Gets or sets the Material. * - :py:attr:`~OutlineSelection` - Gets or sets the OutlineSelection. * - :py:attr:`~PilotNodeAPDLName` - Gets or sets the PilotNodeAPDLName. * - :py:attr:`~PilotNodeScopingType` - Gets or sets the PilotNodeScopingType. * - :py:attr:`~PinballRegion` - Gets or sets the PinballRegion. * - :py:attr:`~Point` - Gets or sets the Point. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~Radius` - Gets or sets the Radius. * - :py:attr:`~ReadOnly` - Gets or sets the ReadOnly. * - :py:attr:`~RelaxationMethod` - Gets or sets the RelaxationMethod. * - :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:`~ScopingMethod` - Gets or sets the ScopingMethod. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. * - :py:attr:`~XComponent` - Gets or sets the XComponent. * - :py:attr:`~XCoordinate` - Gets or sets the XCoordinate. * - :py:attr:`~YComponent` - Gets or sets the YComponent. * - :py:attr:`~YCoordinate` - Gets or sets the YCoordinate. * - :py:attr:`~ZComponent` - Gets or sets the ZComponent. * - :py:attr:`~ZCoordinate` - Gets or sets the ZCoordinate. Property detail --------------- .. py:property:: Behavior :type: Optional[Ansys.Mechanical.DataModel.Enums.LoadBehavior] Gets or sets the Behavior. .. !! processed by numpydoc !! .. 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:: CoordinateSystem :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the CoordinateSystem. .. !! processed by numpydoc !! .. py:property:: DOFSelection :type: Optional[Ansys.Mechanical.DataModel.Enums.RemotePointDOFSelectionType] Gets or sets the DOFSelection. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Formulation :type: Optional[Ansys.Mechanical.DataModel.Enums.RemotePointFormulation] Gets or sets the Formulation. .. !! processed by numpydoc !! .. py:property:: GloballyAvailable :type: Optional[bool] Remote point is globally available .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSRemotePointAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Location :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! processed by numpydoc !! .. py:property:: Material :type: Optional[str] Gets or sets the Material. .. !! processed by numpydoc !! .. py:property:: OutlineSelection :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.RemotePoint]] Gets or sets the OutlineSelection. .. !! processed by numpydoc !! .. py:property:: PilotNodeAPDLName :type: Optional[str] Gets or sets the PilotNodeAPDLName. .. !! processed by numpydoc !! .. py:property:: PilotNodeScopingType :type: Optional[Ansys.Mechanical.DataModel.Enums.PilotNodeScopingType] Gets or sets the PilotNodeScopingType. .. !! processed by numpydoc !! .. py:property:: PinballRegion :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the PinballRegion. .. !! processed by numpydoc !! .. py:property:: Point :type: Optional[Ansys.ACT.Automation.Mechanical.ConstructionPoint] Gets or sets the Point. .. !! 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:: Radius :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the Radius. .. !! processed by numpydoc !! .. py:property:: ReadOnly :type: Optional[bool] Gets or sets the ReadOnly. .. !! processed by numpydoc !! .. py:property:: RelaxationMethod :type: Optional[bool] Gets or sets the RelaxationMethod. .. !! processed by numpydoc !! .. py:property:: RotationX :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the RotationX. .. !! processed by numpydoc !! .. py:property:: RotationY :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the RotationY. .. !! processed by numpydoc !! .. py:property:: RotationZ :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the RotationZ. .. !! processed by numpydoc !! .. py:property:: ScopingMethod :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the ScopingMethod. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[bool] Gets or sets the Suppressed. .. !! 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 !! .. py:property:: XComponent :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the XComponent. .. !! processed by numpydoc !! .. py:property:: XCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the XCoordinate. .. !! processed by numpydoc !! .. py:property:: YComponent :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the YComponent. .. !! processed by numpydoc !! .. py:property:: YCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the YCoordinate. .. !! processed by numpydoc !! .. py:property:: ZComponent :type: Optional[Ansys.Mechanical.DataModel.Enums.ActiveOrInactive] Gets or sets the ZComponent. .. !! processed by numpydoc !! .. py:property:: ZCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ZCoordinate. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: AddCommandSnippet() -> Ansys.ACT.Automation.Mechanical.CommandSnippet Creates a new CommandSnippet .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment Creates a new child Comment. .. !! 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:: GetMeshRegion() -> Ansys.ACT.Interfaces.Mesh.IMeshRegion Returns the mesh region associated to the remote point. .. !! 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:: PromoteToNamedSelection() -> Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection] Run the PromoteToNamedSelection 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 !! .. vale on