`RemotePoint`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.RemotePoint#

Bases: object

Defines a RemotePoint.

Overview#

Methods

`GetMeshRegion`	Returns the mesh region associated to the remote point.
`PromoteToNamedSelection`	Run the PromoteToNamedSelection action.
`AddCommandSnippet`	Creates a new CommandSnippet
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`PilotNodeAPDLName`	Gets or sets the PilotNodeAPDLName.
`OutlineSelection`	Gets or sets the OutlineSelection.
`GloballyAvailable`	Remote point is globally available
`InternalObject`	Gets the internal object. For advanced usage only.
`Material`	Gets or sets the Material.
`Radius`	Gets or sets the Radius.
`XCoordinate`	Gets or sets the XCoordinate.
`YCoordinate`	Gets or sets the YCoordinate.
`ZCoordinate`	Gets or sets the ZCoordinate.
`PinballRegion`	Gets or sets the PinballRegion.
`Behavior`	Gets or sets the Behavior.
`XComponent`	Gets or sets the XComponent.
`YComponent`	Gets or sets the YComponent.
`ZComponent`	Gets or sets the ZComponent.
`DOFSelection`	Gets or sets the DOFSelection.
`ScopingMethod`	Gets or sets the ScopingMethod.
`PilotNodeScopingType`	Gets or sets the PilotNodeScopingType.
`Formulation`	Gets or sets the Formulation.
`RotationX`	Gets or sets the RotationX.
`RotationY`	Gets or sets the RotationY.
`RotationZ`	Gets or sets the RotationZ.
`RelaxationMethod`	Gets or sets the RelaxationMethod.
`Suppressed`	Gets or sets the Suppressed.
`Point`	Gets or sets the Point.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`Location`	Gets or sets the Location.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property RemotePoint.PilotNodeAPDLName: System.String | None: Gets or sets the PilotNodeAPDLName.

property RemotePoint.OutlineSelection: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.RemotePoint] | None: Gets or sets the OutlineSelection.

property RemotePoint.GloballyAvailable: System.Boolean | None: Remote point is globally available

property RemotePoint.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSRemotePointAuto | None: Gets the internal object. For advanced usage only.

property RemotePoint.Material: System.String | None: Gets or sets the Material.

property RemotePoint.Radius: Ansys.Core.Units.Quantity | None: Gets or sets the Radius.

property RemotePoint.XCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the XCoordinate.

property RemotePoint.YCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the YCoordinate.

property RemotePoint.ZCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the ZCoordinate.

property RemotePoint.PinballRegion: Ansys.Core.Units.Quantity | None: Gets or sets the PinballRegion.

property RemotePoint.Behavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None: Gets or sets the Behavior.

property RemotePoint.XComponent: Ansys.Mechanical.DataModel.Enums.ActiveOrInactive | None: Gets or sets the XComponent.

property RemotePoint.YComponent: Ansys.Mechanical.DataModel.Enums.ActiveOrInactive | None: Gets or sets the YComponent.

property RemotePoint.ZComponent: Ansys.Mechanical.DataModel.Enums.ActiveOrInactive | None: Gets or sets the ZComponent.

property RemotePoint.DOFSelection: Ansys.Mechanical.DataModel.Enums.RemotePointDOFSelectionType | None: Gets or sets the DOFSelection.

property RemotePoint.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None: Gets or sets the ScopingMethod.

property RemotePoint.PilotNodeScopingType: Ansys.Mechanical.DataModel.Enums.PilotNodeScopingType | None: Gets or sets the PilotNodeScopingType.

property RemotePoint.Formulation: Ansys.Mechanical.DataModel.Enums.RemotePointFormulation | None: Gets or sets the Formulation.

property RemotePoint.RotationX: Ansys.Mechanical.DataModel.Enums.ActiveOrInactive | None: Gets or sets the RotationX.

property RemotePoint.RotationY: Ansys.Mechanical.DataModel.Enums.ActiveOrInactive | None: Gets or sets the RotationY.

property RemotePoint.RotationZ: Ansys.Mechanical.DataModel.Enums.ActiveOrInactive | None: Gets or sets the RotationZ.

property RemotePoint.RelaxationMethod: System.Boolean | None: Gets or sets the RelaxationMethod.

property RemotePoint.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property RemotePoint.Point: Ansys.ACT.Automation.Mechanical.ConstructionPoint | None: Gets or sets the Point.

property RemotePoint.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the CoordinateSystem.

property RemotePoint.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property RemotePoint.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property RemotePoint.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property RemotePoint.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property RemotePoint.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property RemotePoint.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property RemotePoint.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property RemotePoint.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

RemotePoint.GetMeshRegion() → Ansys.ACT.Interfaces.Mesh.IMeshRegion: Returns the mesh region associated to the remote point.

RemotePoint.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]: Run the PromoteToNamedSelection action.

RemotePoint.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet: Creates a new CommandSnippet

RemotePoint.Delete() → System.Void: Run the Delete action.

RemotePoint.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

RemotePoint.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]: Gets the list of children, filtered by type.

RemotePoint.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

RemotePoint.Activate() → System.Void: Activate the current object.

RemotePoint.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

RemotePoint.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

RemotePoint.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

RemotePoint.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

RemotePoint.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

RemotePoint.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

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.

RemotePoint.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

RemotePoint.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

RemotePoint.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.