Solid

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

Bases: object

Defines a Solid.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddGeometry	Add solid to the geometry.
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.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveGeometry	Remove the solid from the geometry.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.
UpdateGeometry	Update the solid on the geometry.

Properties

AttachedRefs	AttachedRefs property.
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.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
PartName	Gets the PartName.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
State	State property.
TransferableObjectId	TransferableObjectId property.
VisibleProperties	Gets the list of properties that are visible for this object.
X1	Gets or sets the X1.
X2	Gets or sets the X2.
Y1	Gets or sets the Y1.
Y2	Gets or sets the Y2.
Z1	Gets or sets the Z1.
Z2	Gets or sets the Z2.

Property detail

property Solid.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property Solid.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject's category.

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

GroupingFolder property.

property Solid.IconName: str | None

IconName property.

property Solid.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property Solid.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSSolidAuto | None

Gets the internal object. For advanced usage only.

property Solid.Name: str | None

Name property.

property Solid.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

property Solid.PartName: str | None

Gets the PartName.

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

Gets the list of properties for this object.

property Solid.ReadOnly: bool | None

Gets or sets the ReadOnly.

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

State property.

property Solid.TransferableObjectId: str | None

TransferableObjectId property.

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

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

property Solid.X1: Ansys.Core.Units.Quantity | None

Gets or sets the X1.

property Solid.X2: Ansys.Core.Units.Quantity | None

Gets or sets the X2.

property Solid.Y1: Ansys.Core.Units.Quantity | None

Gets or sets the Y1.

property Solid.Y2: Ansys.Core.Units.Quantity | None

Gets or sets the Y2.

property Solid.Z1: Ansys.Core.Units.Quantity | None

Gets or sets the Z1.

property Solid.Z2: Ansys.Core.Units.Quantity | None

Gets or sets the Z2.

Method detail

Solid.Activate() → None

Activate the current object.

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

Creates a new child Comment.

Solid.AddGeometry() → None

Add solid to the geometry.

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

Solid.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

Solid.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

Solid.GetHashCode() → int

GetHashCode method.

Solid.GetIconFile() → System.Byte

GetIconFile method.

Solid.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

Solid.GetPath() → str

GetPath method.

Solid.GetPropertyName(dispId: int) → str

GetPropertyName method.

Solid.GetPropertyValue(name: str) → Any

GetPropertyValue method.

Solid.GetType() → type

GetType method.

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

GetVisibleProperties method.

Solid.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

Solid.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Solid.InitializeLifetimeService() → Any

InitializeLifetimeService method.

Solid.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

Solid.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

Solid.RemoveGeometry() → None

Remove the solid from the geometry.

Solid.RemoveParameter(propName: str) → None

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

Solid.ToString() → str

ToString method.

Solid.UpdateGeometry() → None

Update the solid on the geometry.