DistributedMass
Last update: 14.01.2025
DistributedMass
class Ansys.ACT.Automation.Mechanical.DistributedMass
Bases: object
Defines a DistributedMass.
Overview
Methods
Name | Description |
---|---|
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. |
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. |
GetParameter |
Gets the parameter corresponding to the given property. |
GroupAllSimilarChildren |
Run the GroupAllSimilarChildren action. |
GroupSimilarObjects |
Run the GroupSimilarObjects 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. |
Properties
Name | Description |
---|---|
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
ElementAPDLName |
Gets or sets the ElementAPDLName. |
Figures |
Gets the list of associated figures. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
IsDistributedMass |
Gets the IsDistributedMass. |
Location |
Gets or sets the Geometry. |
MassPerUnitArea |
Gets or sets the MassPerUnitArea. |
MassType |
Gets or sets the MassType. |
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. |
Suppressed |
Gets or sets the Suppressed. |
TotalMass |
Gets or sets the TotalMass. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property DistributedMass.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property DistributedMass.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property DistributedMass.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property DistributedMass.ElementAPDLName : str | None
Gets or sets the ElementAPDLName.
property DistributedMass.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property DistributedMass.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property DistributedMass.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSPointMassAuto | None
Gets the internal object. For advanced usage only.
property DistributedMass.IsDistributedMass : bool | None
Gets the IsDistributedMass.
property DistributedMass.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Geometry.
property DistributedMass.MassPerUnitArea : Ansys.Core.Units.Quantity | None
Gets or sets the MassPerUnitArea.
property DistributedMass.MassType : Ansys.Mechanical.DataModel.Enums.DistributedMassInputType | None
Gets or sets the MassType.
property DistributedMass.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property DistributedMass.ReadOnly : bool | None
Gets or sets the ReadOnly.
property DistributedMass.RemotePoint : Ansys.ACT.Automation.Mechanical.RemotePoint | None
Gets the remote point associated to the point mass.
property DistributedMass.Suppressed : bool | None
Gets or sets the Suppressed.
property DistributedMass.TotalMass : Ansys.Core.Units.Quantity | None
Gets or sets the TotalMass.
property DistributedMass.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
DistributedMass.Activate()
Activate the current object.
DistributedMass.AddCommandSnippet()
Creates a new CommandSnippet
DistributedMass.AddComment()
Creates a new child Comment.
DistributedMass.AddFigure()
Creates a new child Figure.
DistributedMass.AddImage(filePath: str)
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.
DistributedMass.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
DistributedMass.CreateParameter(propName: str)
Creates a new parameter for a Property.
DistributedMass.Delete()
Run the Delete action.
DistributedMass.Duplicate()
Creates a copy of the current DataModelObject.
DistributedMass.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
DistributedMass.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
DistributedMass.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
DistributedMass.GroupSimilarObjects()
Run the GroupSimilarObjects action.
DistributedMass.PropertyByAPIName(name: str)
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.
DistributedMass.PropertyByName(name: str)
Get a property by its unique name.
DistributedMass.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.