RemotePoint#

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

Bases: object

Defines a RemotePoint.

Overview#

Activate

Activate the current object.

AddCommandSnippet

Creates a new CommandSnippet

AddComment

Creates a new child Comment.

CopyTo

Copies all visible properties from this object to another.

CreateParameter

Creates a new parameter for a Property.

Delete

Run the Delete action.

Duplicate

Creates a copy of the current DataModelObject.

GetChildren

Gets the list of children, filtered by type.

GetMeshRegion

Returns the mesh region associated to the remote point.

GetParameter

Gets the parameter corresponding to the given property.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

PromoteToNamedSelection

Run the PromoteToNamedSelection action.

PropertyByAPIName

Get a property by its API name.

PropertyByName

Get a property by its unique name.

RemoveParameter

Removes the parameter from the parameter set corresponding to the given property.

Behavior

Gets or sets the Behavior.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

CoordinateSystem

Gets or sets the CoordinateSystem.

DOFSelection

Gets or sets the DOFSelection.

DataModelObjectCategory

Gets the current DataModelObject's category.

Formulation

Gets or sets the Formulation.

GloballyAvailable

Remote point is globally available

InternalObject

Gets the internal object. For advanced usage only.

Location

Gets or sets the Location.

Material

Gets or sets the Material.

OutlineSelection

Gets or sets the OutlineSelection.

PilotNodeAPDLName

Gets or sets the PilotNodeAPDLName.

PilotNodeScopingType

Gets or sets the PilotNodeScopingType.

PinballRegion

Gets or sets the PinballRegion.

Point

Gets or sets the Point.

Properties

Gets the list of properties for this object.

Radius

Gets or sets the Radius.

ReadOnly

Gets or sets the ReadOnly.

RelaxationMethod

Gets or sets the RelaxationMethod.

RotationX

Gets or sets the RotationX.

RotationY

Gets or sets the RotationY.

RotationZ

Gets or sets the RotationZ.

ScopingMethod

Gets or sets the ScopingMethod.

Suppressed

Gets or sets the Suppressed.

VisibleProperties

Gets the list of properties that are visible for this object.

XComponent

Gets or sets the XComponent.

XCoordinate

Gets or sets the XCoordinate.

YComponent

Gets or sets the YComponent.

YCoordinate

Gets or sets the YCoordinate.

ZComponent

Gets or sets the ZComponent.

ZCoordinate

Gets or sets the ZCoordinate.

Property detail#

property RemotePoint.Behavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None#

Gets or sets the Behavior.

property RemotePoint.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets the list of children.

property RemotePoint.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#

Gets the list of associated comments.

property RemotePoint.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the CoordinateSystem.

property RemotePoint.DOFSelection: Ansys.Mechanical.DataModel.Enums.RemotePointDOFSelectionType | None#

Gets or sets the DOFSelection.

property RemotePoint.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property RemotePoint.Formulation: Ansys.Mechanical.DataModel.Enums.RemotePointFormulation | None#

Gets or sets the Formulation.

property RemotePoint.GloballyAvailable: bool | 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.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property RemotePoint.Material: str | None#

Gets or sets the Material.

property RemotePoint.OutlineSelection: Iterable[Ansys.ACT.Automation.Mechanical.RemotePoint] | None#

Gets or sets the OutlineSelection.

property RemotePoint.PilotNodeAPDLName: str | None#

Gets or sets the PilotNodeAPDLName.

property RemotePoint.PilotNodeScopingType: Ansys.Mechanical.DataModel.Enums.PilotNodeScopingType | None#

Gets or sets the PilotNodeScopingType.

property RemotePoint.PinballRegion: Ansys.Core.Units.Quantity | None#

Gets or sets the PinballRegion.

property RemotePoint.Point: Ansys.ACT.Automation.Mechanical.ConstructionPoint | None#

Gets or sets the Point.

property RemotePoint.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties for this object.

property RemotePoint.Radius: Ansys.Core.Units.Quantity | None#

Gets or sets the Radius.

property RemotePoint.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property RemotePoint.RelaxationMethod: bool | None#

Gets or sets the RelaxationMethod.

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.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#

Gets or sets the ScopingMethod.

property RemotePoint.Suppressed: bool | None#

Gets or sets the Suppressed.

property RemotePoint.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties that are visible for this object.

property RemotePoint.XComponent: Ansys.Mechanical.DataModel.Enums.ActiveOrInactive | None#

Gets or sets the XComponent.

property RemotePoint.XCoordinate: Ansys.Core.Units.Quantity | None#

Gets or sets the XCoordinate.

property RemotePoint.YComponent: Ansys.Mechanical.DataModel.Enums.ActiveOrInactive | None#

Gets or sets the YComponent.

property RemotePoint.YCoordinate: Ansys.Core.Units.Quantity | None#

Gets or sets the YCoordinate.

property RemotePoint.ZComponent: Ansys.Mechanical.DataModel.Enums.ActiveOrInactive | None#

Gets or sets the ZComponent.

property RemotePoint.ZCoordinate: Ansys.Core.Units.Quantity | None#

Gets or sets the ZCoordinate.

Method detail#

RemotePoint.Activate() None#

Activate the current object.

RemotePoint.AddCommandSnippet() Ansys.ACT.Automation.Mechanical.CommandSnippet#

Creates a new CommandSnippet

RemotePoint.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

RemotePoint.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

RemotePoint.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

RemotePoint.Delete() None#

Run the Delete action.

RemotePoint.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

RemotePoint.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

RemotePoint.GetMeshRegion() Ansys.ACT.Interfaces.Mesh.IMeshRegion#

Returns the mesh region associated to the remote point.

RemotePoint.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

RemotePoint.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

RemotePoint.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

RemotePoint.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

RemotePoint.PropertyByAPIName(name: str) 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.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

RemotePoint.RemoveParameter(propName: str) None#

Removes the parameter from the parameter set corresponding to the given property.