RemotePoint

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.RemotePoint(internalObject: Any)

Bases: object

Defines a RemotePoint.

Overview

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetMeshRegion	Returns the mesh region associated to the remote point.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
BeamCoincidentLengthFactor	Gets or sets the Coincident Length Factor that scales the stiffness of the connection between the beam elements and the remote point. This property is applicable when Behavior is set to “Beam”. Default: 1.
Behavior	Gets or sets the Behavior.
Children	Gets the list of children.
ClsId	ClsId property.
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
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Id	Id property.
Ids	Ids property.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
Material	Gets or sets the Material.
MeshRegionId	MeshRegionId property.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OutlineSelection	Gets or sets the OutlineSelection.
Parent	Parent property.
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.
SelectionType	SelectionType property.
State	State property.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

property RemotePoint.BeamCoincidentLengthFactor: float | None

Gets or sets the Coincident Length Factor that scales the stiffness of the connection between the beam elements and the remote point. This property is applicable when Behavior is set to “Beam”. Default: 1.

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.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property RemotePoint.IconName: str | None

IconName property.

property RemotePoint.Id: int | None

Id property.

property RemotePoint.Ids: List[int] | None

Ids property.

property RemotePoint.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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.MeshRegionId: int | None

MeshRegionId property.

property RemotePoint.Name: str | None

Name property.

property RemotePoint.ObjectId: int | None

ObjectId property.

property RemotePoint.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property RemotePoint.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

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

Gets or sets the OutlineSelection.

property RemotePoint.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.SelectionType: Ansys.ACT.Interfaces.Common.SelectionTypeEnum | None

SelectionType property.

property RemotePoint.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property RemotePoint.Suppressed: bool | None

Gets or sets the Suppressed.

property RemotePoint.TransferableObjectId: str | None

TransferableObjectId property.

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.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

RemotePoint.GetAPIName(dispId: int) → str

Property name bound to dispId.

RemotePoint.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

RemotePoint.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

RemotePoint.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

RemotePoint.GetHashCode() → int

GetHashCode method.

RemotePoint.GetIconFile() → System.Byte

GetIconFile method.

RemotePoint.GetLifetimeService() → Any

GetLifetimeService method.

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

Returns the mesh region associated to the remote point.

RemotePoint.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

RemotePoint.GetPath() → str

GetPath method.

RemotePoint.GetPropertyName(dispId: int) → str

GetPropertyName method.

RemotePoint.GetPropertyValue(name: str) → Any

GetPropertyValue method.

RemotePoint.GetType() → type

GetType method.

RemotePoint.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

RemotePoint.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

RemotePoint.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

RemotePoint.InitializeLifetimeService() → Any

InitializeLifetimeService method.

RemotePoint.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

RemotePoint.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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.

RemotePoint.ToString() → str

ToString method.