ApiElementItem

class ansys.rocky.app.api_element_item.ApiElementItem(id: str, model_id: str | None = None)

Base wrapper class for all subjects.

Variables:

• id (unicode) – The id of the subject

• _model_id (unicode) – The id of the input reader associated with the subject

Overview

Constructors

GetWrappedClass
GetClassName
GetChildrenClassesToIgnore	If there are some children classes to ignore the children should override and return them

Methods

GetDataId	returns:
IsValid	returns:
GetSubject	returns:
GetName	Get the element’s name.
SetName	Set the process name
SetSelected	Sets this item as the current item (selected).
Select	Select all the elements in the application that are child of this element with the given names

Attributes

id
subject
name

Import detail

from ansys.rocky.app.api_element_item import ApiElementItem

Attribute detail

ApiElementItem.id: _typeshed.Incomplete

ApiElementItem.subject: _typeshed.Incomplete

ApiElementItem.name: _typeshed.Incomplete

Method detail

classmethod ApiElementItem.GetWrappedClass() → type

classmethod ApiElementItem.GetClassName() → str

classmethod ApiElementItem.GetChildrenClassesToIgnore() → list[type]

If there are some children classes to ignore the children should override and return them in this method.

ApiElementItem.GetDataId() → str

Returns:

The element pool id

ApiElementItem.IsValid() → bool

Returns:

True if the given API object is associated to a valid/existing subject

ApiElementItem.GetSubject() → coilib50.subject.Subject

Returns:

The element associated with the element id

ApiElementItem.GetName() → str

Get the element’s name.

Returns:

The name of the element in the application

ApiElementItem.SetName(name: str) → None

Set the process name

Parameters:

name – The name of the process

ApiElementItem.SetSelected() → None

Sets this item as the current item (selected).

ApiElementItem.Select(element_names: list[str]) → None

Select all the elements in the application that are child of this element with the given names

Parameters:

element_names (list(unicode)) – The list of element names