AMSupportGroup

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

Bases: object

Defines a AMSupportGroup.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddGeneratedAMSupport	Creates a new GeneratedAMSupport
AddImage	Creates a new child Image.
AddPredefinedAMSupport	Creates a new PredefinedAMSupport
AddSTLAMSupport	Creates a new GeneratedAMSupport
Clean	Clean method.
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.
DetectSupportFaces	Runs the Detect Support Faces 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.
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.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
DetectAboveZLocation	Gets or sets the DetectAboveZLocation.
Figures	Gets the list of associated figures.
GenerateOnRemesh	Gets or sets the GenerateOnRemesh.
GroupingFolder	GroupingFolder property.
HangAngle	Gets or sets the HangAngle.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OutputType	Gets or sets the OutputType.
Parent	Parent property.
Properties	Gets the list of properties for this object.
State	State property.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property AMSupportGroup.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property AMSupportGroup.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property AMSupportGroup.DetectAboveZLocation: Ansys.Core.Units.Quantity | None

Gets or sets the DetectAboveZLocation.

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

Gets the list of associated figures.

property AMSupportGroup.GenerateOnRemesh: bool | None

Gets or sets the GenerateOnRemesh.

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

GroupingFolder property.

property AMSupportGroup.HangAngle: Ansys.Core.Units.Quantity | None

Gets or sets the HangAngle.

property AMSupportGroup.IconName: str | None

IconName property.

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

Gets the list of associated images.

property AMSupportGroup.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSAMSupportGroupAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property AMSupportGroup.Name: str | None

Name property.

property AMSupportGroup.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property AMSupportGroup.OutputType: Ansys.Mechanical.DataModel.Enums.AMSupportGroupOutputType | None

Gets or sets the OutputType.

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

Parent property.

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

Gets the list of properties for this object.

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

State property.

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

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

Method detail

AMSupportGroup.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

AMSupportGroup.AddGeneratedAMSupport() → Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.GeneratedAMSupport

Creates a new GeneratedAMSupport

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

AMSupportGroup.AddPredefinedAMSupport() → Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.PredefinedAMSupport

Creates a new PredefinedAMSupport

AMSupportGroup.AddSTLAMSupport() → Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.STLAMSupport

Creates a new GeneratedAMSupport

AMSupportGroup.Clean() → None

Clean method.

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

AMSupportGroup.Delete() → None

Run the Delete action.

AMSupportGroup.DetectSupportFaces() → Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Runs the Detect Support Faces action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

AMSupportGroup.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

AMSupportGroup.GetHashCode() → int

GetHashCode method.

AMSupportGroup.GetIconFile() → System.Byte

GetIconFile method.

AMSupportGroup.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

AMSupportGroup.GetPath() → str

GetPath method.

AMSupportGroup.GetPropertyName(dispId: int) → str

GetPropertyName method.

AMSupportGroup.GetPropertyValue(name: str) → Any

GetPropertyValue method.

AMSupportGroup.GetType() → type

GetType method.

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

GetVisibleProperties method.

AMSupportGroup.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

AMSupportGroup.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

AMSupportGroup.InitializeLifetimeService() → Any

InitializeLifetimeService method.

AMSupportGroup.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

AMSupportGroup.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

AMSupportGroup.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

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

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

PropertyById method.

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

Get a property by its unique name.

AMSupportGroup.RemoveParameter(propName: str) → None

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

AMSupportGroup.ToString() → str

ToString method.