`PointMass`#

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

Bases: object

Defines a PointMass.

Overview#

Methods

`PromoteToRemotePoint`	Run the PromoteToRemotePoint 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.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`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

`ElementAPDLName`	Gets or sets the ElementAPDLName.
`InternalObject`	Gets the internal object. For advanced usage only.
`Material`	Gets or sets the Material.
`BeamRadius`	Gets or sets the BeamRadius.
`XCoordinate`	Gets or sets the XCoordinate.
`YCoordinate`	Gets or sets the YCoordinate.
`ZCoordinate`	Gets or sets the ZCoordinate.
`Mass`	Gets or sets the Mass.
`MassMomentOfInertiaX`	Gets or sets the MassMomentOfInertiaX.
`MassMomentOfInertiaY`	Gets or sets the MassMomentOfInertiaY.
`MassMomentOfInertiaZ`	Gets or sets the MassMomentOfInertiaZ.
`PinballRegion`	Gets or sets the PinballRegion.
`AppliedBy`	Gets or sets the AppliedBy.
`Behavior`	Gets or sets the Behavior.
`Suppressed`	Gets or sets the Suppressed.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`NodalCoordinateSystem`	Gets the NodalCoordinateSystem.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`RemotePoint`	Gets the remote point associated to the point mass.
`IsDistributedMass`	Gets the IsDistributedMass.
`Location`	Gets or sets the Geometry.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`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 PointMass.ElementAPDLName: System.String | None: Gets or sets the ElementAPDLName.

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

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

property PointMass.BeamRadius: Ansys.Core.Units.Quantity | None: Gets or sets the BeamRadius.

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.

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.PinballRegion: Ansys.Core.Units.Quantity | None: Gets or sets the PinballRegion.

property PointMass.AppliedBy: Ansys.Mechanical.DataModel.Enums.RemoteApplicationType | None: Gets or sets the AppliedBy.

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

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

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

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

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

property PointMass.RemotePoint: Ansys.ACT.Automation.Mechanical.RemotePoint | None: Gets the remote point associated to the point mass.

property PointMass.IsDistributedMass: System.Boolean | None: Gets the IsDistributedMass.

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

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

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

property PointMass.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property PointMass.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

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

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

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

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

Method detail#

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

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

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

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

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

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: System.String) → 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.Activate() → System.Void: Activate the current object.

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

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

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

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

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

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

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

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

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