RAList

class ansys.rocky.app.ra_list.RAList(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem, Generic[T]

Base class for API classes that wrap SubjectLists (and related list classes).

Provides methods to add, remove and iterate on the items. The PrePost Scripting wrappers for the list items will be obtained via ApiApplication._GetElementWrapper(), so it’s important that these wrappers are registered as wrapper classes (see EPApiExtension).

Overview

Methods

New	Add a new item. Returns the newly created item.
Remove	Remove an item from the list.
Clear	Remove all items from the list.

Special methods

__len__
__getitem__
__iter__
__delitem__

Import detail

from ansys.rocky.app.ra_list import RAList

Method detail

RAList.New() → T

Add a new item. Returns the newly created item.

RAList.Remove(item: T) → None

Remove an item from the list.

RAList.Clear() → None

Remove all items from the list.

RAList.__len__() → int

RAList.__getitem__(index: int) → T

RAList.__iter__() → collections.abc.Generator[T, None, None]

RAList.__delitem__(index: int) → None