NamedSelection

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

Bases: object

Defines a NamedSelection.

Overview

Methods

Activate	Activate the current object.
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.
CreateNodalNamedSelection	Creates a new Named Selection object containing all the nodes from the entities in the current named selection .
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.
ExportNamedSelectionToCDBFile	Export Named Selection to CDB file
ExportToTextFile	ExportToTextFile method.
Generate	Generates the selection based on the generation criteria.
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.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
SendToMeshWorkflowByType	Creates a new MeshWorkflowGroup
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
CrackFrontNumber	Gets the CrackFrontNumber.
CreatedForCrack	Gets the CreatedForCrack.
DataModelObjectCategory	Gets the current DataModelObject's category.
ElementFaceIndices	ElementFaceIndices property.
Entities	Entities property.
Figures	Gets the list of associated figures.
GenerationCriteria	Returns the generation criteria that is used to generate the selection.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Id	Id property.
Ids	Ids property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
IncludeProgramControlledInflation	Gets or sets the IncludeProgramControlledInflation.
InternalObject	Gets the internal object. For advanced usage only.
IsValid	IsValid property.
LSDynaUserId	Gets or sets the LSDynaUserId.
Location	Gets or sets the Location.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
PreserveDuringSolve	Gets or sets the PreserveDuringSolve.
Properties	Gets the list of properties for this object.
Protected	Gets or sets how the corresponding contact entities (faces, edges or vertices) are protected while meshing. Default:Program Controlled
ReadOnly	Gets or sets the ReadOnly.
RelativeTolerance	Gets or sets the RelativeTolerance.
ScopingMethod	Gets or sets the ScopingMethod.
SelectionType	SelectionType property.
SendAs	Gets or sets the SendAs.
SendToSolver	Gets or sets the SendToSolver.
SolverName	SolverName property.
State	State property.
Suppressed	Gets the Suppressed.
ToleranceType	Gets or sets the ToleranceType.
TotalSelection	Gets the TotalSelection.
TransferableObjectId	TransferableObjectId property.
Type	Gets the Type.
UsedByMeshWorksheet	Gets the UsedByMeshWorksheet.
Visible	Gets or sets the Visible.
VisibleProperties	Gets the list of properties that are visible for this object.
Worksheet	For testing compatibility, maintains old Location property/behavior
ZeroTolerance	Gets or sets the ZeroTolerance.

Property detail

property NamedSelection.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property NamedSelection.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property NamedSelection.CrackFrontNumber: int | None

Gets the CrackFrontNumber.

property NamedSelection.CreatedForCrack: Ansys.ACT.Automation.Mechanical.GenericCrack | None

Gets the CreatedForCrack.

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

Gets the current DataModelObject's category.

property NamedSelection.ElementFaceIndices: List[int] | None

ElementFaceIndices property.

property NamedSelection.Entities: List[Ansys.ACT.Interfaces.Geometry.IGeoEntity] | None

Entities property.

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

Gets the list of associated figures.

property NamedSelection.GenerationCriteria: Ansys.ACT.Automation.Mechanical.NamedSelectionCriteria | None

Returns the generation criteria that is used to generate the selection.

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

GroupingFolder property.

property NamedSelection.IconName: str | None

IconName property.

property NamedSelection.Id: int | None

Id property.

property NamedSelection.Ids: List[int] | None

Ids property.

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

Gets the list of associated images.

property NamedSelection.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property NamedSelection.IncludeProgramControlledInflation: bool | None

Gets or sets the IncludeProgramControlledInflation.

property NamedSelection.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSComponentAuto | None

Gets the internal object. For advanced usage only.

property NamedSelection.IsValid: bool | None

IsValid property.

property NamedSelection.LSDynaUserId: int | None

Gets or sets the LSDynaUserId.

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

Gets or sets the Location.

property NamedSelection.Name: str | None

Name property.

property NamedSelection.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

property NamedSelection.PreserveDuringSolve: bool | None

Gets or sets the PreserveDuringSolve.

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

Gets the list of properties for this object.

property NamedSelection.Protected: Ansys.Mechanical.DataModel.Enums.ComponentProtectedType | None

Gets or sets how the corresponding contact entities (faces, edges or vertices) are protected while meshing. Default:Program Controlled

property NamedSelection.ReadOnly: bool | None

Gets or sets the ReadOnly.

property NamedSelection.RelativeTolerance: float | None

Gets or sets the RelativeTolerance.

property NamedSelection.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property NamedSelection.SelectionType: Ansys.ACT.Interfaces.Common.SelectionTypeEnum | None

SelectionType property.

property NamedSelection.SendAs: Ansys.Mechanical.DataModel.Enums.SendAs | None

Gets or sets the SendAs.

property NamedSelection.SendToSolver: bool | None

Gets or sets the SendToSolver.

property NamedSelection.SolverName: str | None

SolverName property.

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

State property.

property NamedSelection.Suppressed: int | None

Gets the Suppressed.

property NamedSelection.ToleranceType: Ansys.Mechanical.DataModel.Enums.ToleranceType | None

Gets or sets the ToleranceType.

property NamedSelection.TotalSelection: int | None

Gets the TotalSelection.

property NamedSelection.TransferableObjectId: str | None

TransferableObjectId property.

property NamedSelection.Type: bool | None

Gets the Type.

property NamedSelection.UsedByMeshWorksheet: bool | None

Gets the UsedByMeshWorksheet.

property NamedSelection.Visible: bool | None

Gets or sets the Visible.

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

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

property NamedSelection.Worksheet: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

For testing compatibility, maintains old Location property/behavior

property NamedSelection.ZeroTolerance: float | None

Gets or sets the ZeroTolerance.

Method detail

NamedSelection.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

NamedSelection.CreateNodalNamedSelection() → Ansys.ACT.Automation.Mechanical.NamedSelection

Creates a new Named Selection object containing all the nodes from the entities in the current named selection .

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

CreateObjRef method.

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

Creates a new parameter for a Property.

NamedSelection.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

NamedSelection.ExportNamedSelectionToCDBFile(filepath: str) → None

Export Named Selection to CDB file

NamedSelection.ExportToTextFile(bIgnoreExcelPreference: bool, filePath: str) → None

ExportToTextFile method.

NamedSelection.Generate() → None

Generates the selection based on the generation criteria.

NamedSelection.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

NamedSelection.GetHashCode() → int

GetHashCode method.

NamedSelection.GetIconFile() → System.Byte

GetIconFile method.

NamedSelection.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

NamedSelection.GetPath() → str

GetPath method.

NamedSelection.GetPropertyName(dispId: int) → str

GetPropertyName method.

NamedSelection.GetPropertyValue(name: str) → Any

GetPropertyValue method.

NamedSelection.GetType() → type

GetType method.

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

GetVisibleProperties method.

NamedSelection.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

NamedSelection.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

NamedSelection.InitializeLifetimeService() → Any

InitializeLifetimeService method.

NamedSelection.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

NamedSelection.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

NamedSelection.RemoveParameter(propName: str) → None

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

NamedSelection.SendToMeshWorkflowByType(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WorkflowType) → Ansys.ACT.Automation.Mechanical.MeshWorkflow

Creates a new MeshWorkflowGroup

NamedSelection.ToString() → str

ToString method.