PointMass

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

Bases: object

Defines a PointMass.

Overview

Methods

Activate	Activate the current object.
AddCommandSnippet	Creates a new CommandSnippet
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
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.
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.
PromoteToRemotePoint	Run the PromoteToRemotePoint 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

AppliedBy	Gets or sets the AppliedBy.
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.
BeamRadius	Gets or sets the BeamRadius.
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.
DataModelObjectCategory	Gets the current DataModelObject's category.
ElementAPDLName	Gets or sets the ElementAPDLName.
Figures	Gets the list of associated figures.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
IsDistributedMass	Gets the IsDistributedMass.
Location	Gets or sets the Geometry.
Mass	Gets or sets the Mass.
MassMomentOfInertiaX	Gets or sets the MassMomentOfInertiaX.
MassMomentOfInertiaY	Gets or sets the MassMomentOfInertiaY.
MassMomentOfInertiaZ	Gets or sets the MassMomentOfInertiaZ.
Material	Gets or sets the Material.
Name	Name property.
NodalCoordinateSystem	Gets the NodalCoordinateSystem.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
PinballRegion	Gets or sets the PinballRegion.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
RemotePoint	Gets the remote point associated to the point mass.
State	State property.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
VisibleProperties	Gets the list of properties that are visible for this object.
XCoordinate	Gets or sets the XCoordinate.
YCoordinate	Gets or sets the YCoordinate.
ZCoordinate	Gets or sets the ZCoordinate.

Property detail

property PointMass.AppliedBy: Ansys.Mechanical.DataModel.Enums.RemoteApplicationType | None

Gets or sets the AppliedBy.

property PointMass.AttachedRefs: List[int] | None

AttachedRefs property.

property PointMass.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 PointMass.BeamRadius: Ansys.Core.Units.Quantity | None

Gets or sets the BeamRadius.

property PointMass.Behavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the Behavior.

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

Gets the list of children.

property PointMass.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property PointMass.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

property PointMass.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject's category.

property PointMass.ElementAPDLName: str | None

Gets or sets the ElementAPDLName.

property PointMass.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property PointMass.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property PointMass.IconName: str | None

IconName property.

property PointMass.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property PointMass.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property PointMass.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSPointMassAuto | None

Gets the internal object. For advanced usage only.

property PointMass.IsDistributedMass: bool | None

Gets the IsDistributedMass.

property PointMass.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Geometry.

property PointMass.Mass: Ansys.Core.Units.Quantity | None

Gets or sets the Mass.

property PointMass.MassMomentOfInertiaX: Ansys.Core.Units.Quantity | None

Gets or sets the MassMomentOfInertiaX.

property PointMass.MassMomentOfInertiaY: Ansys.Core.Units.Quantity | None

Gets or sets the MassMomentOfInertiaY.

property PointMass.MassMomentOfInertiaZ: Ansys.Core.Units.Quantity | None

Gets or sets the MassMomentOfInertiaZ.

property PointMass.Material: str | None

Gets or sets the Material.

property PointMass.Name: str | None

Name property.

property PointMass.NodalCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets the NodalCoordinateSystem.

property PointMass.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

property PointMass.PinballRegion: Ansys.Core.Units.Quantity | None

Gets or sets the PinballRegion.

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

Gets the list of properties for this object.

property PointMass.ReadOnly: bool | None

Gets or sets the ReadOnly.

property PointMass.RemotePoint: Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets the remote point associated to the point mass.

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

State property.

property PointMass.Suppressed: bool | None

Gets or sets the Suppressed.

property PointMass.TransferableObjectId: str | None

TransferableObjectId property.

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

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

property PointMass.XCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the XCoordinate.

property PointMass.YCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the YCoordinate.

property PointMass.ZCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the ZCoordinate.

Method detail

PointMass.Activate() → None

Activate the current object.

PointMass.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet

Creates a new CommandSnippet

PointMass.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

PointMass.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

PointMass.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image

Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

PointMass.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

PointMass.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

PointMass.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

PointMass.Delete() → None

Run the Delete action.

PointMass.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

PointMass.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

PointMass.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

PointMass.GetHashCode() → int

GetHashCode method.

PointMass.GetIconFile() → System.Byte

GetIconFile method.

PointMass.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

PointMass.GetPath() → str

GetPath method.

PointMass.GetPropertyName(dispId: int) → str

GetPropertyName method.

PointMass.GetPropertyValue(name: str) → Any

GetPropertyValue method.

PointMass.GetType() → type

GetType method.

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

GetVisibleProperties method.

PointMass.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

PointMass.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

PointMass.InitializeLifetimeService() → Any

InitializeLifetimeService method.

PointMass.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

PointMass.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

PointMass.PromoteToRemotePoint() → Iterable[Ansys.ACT.Automation.Mechanical.RemotePoint]

Run the PromoteToRemotePoint action.

PointMass.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.

PointMass.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

PointMass.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

PointMass.RemoveParameter(propName: str) → None

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

PointMass.ToString() → str

ToString method.