ArrayOfSpeciesIsotope

class pyarts3.arts.ArrayOfSpeciesIsotope(*args, **kwargs)

A list of SpeciesIsotope

Sizes

A variable x of this group may name 1 dimension, read as x.size().

Overview

Method	`append()`	Append arg to the end of the list.
Method	`appendxml()`	Append variable from file.
Method	`clear()`	Remove all items from list.
Method	`count()`	Return number of occurrences of arg.
Method	`extend()`	Extend self by appending elements from arg.
Method	`extendxml()`	Extend variable from file.
Method	`insert()`	Insert object arg1 before index arg0.
Method	`pop()`	Remove and return item at index (default last).
Method	`readxml()`	Read variable from file.
Method	`remove()`	Remove first occurrence of arg.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
Static Method	`fromxmls()`	Create variable from file.
Operator	`__contains__()`	`__contains__(self, arg: object, /) -> bool`
Operator	`__delitem__()`	`__delitem__(self, arg: slice, /) -> None`
Operator	`__eq__()`	`__eq__(self, arg: pyarts3.arts.ArrayOfSpeciesIsotope, /) -> bool`
Operator	`__format__()`	`__format__(self, arg: str, /) -> str`
Operator	`__ge__()`	`__ge__(self, arg: pyarts3.arts.ArrayOfSpeciesIsotope, /) -> bool`
Operator	`__getitem__()`	`__getitem__(self, arg: slice, /) -> pyarts3.arts.ArrayOfSpeciesIsotope`
Operator	`__gt__()`	`__gt__(self, arg: pyarts3.arts.ArrayOfSpeciesIsotope, /) -> bool`
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	Overloaded function.
Operator	`__iter__()`	`__iter__(self) -> collections.abc.Iterator[pyarts3.arts.SpeciesIsotope]`
Operator	`__le__()`	`__le__(self, arg: pyarts3.arts.ArrayOfSpeciesIsotope, /) -> bool`
Operator	`__len__()`	`__len__(self) -> int`
Operator	`__lt__()`	`__lt__(self, arg: pyarts3.arts.ArrayOfSpeciesIsotope, /) -> bool`
Operator	`__ne__()`	`__ne__(self, arg: pyarts3.arts.ArrayOfSpeciesIsotope, /) -> bool`
Operator	`__repr__()`	`__repr__(self) -> str`
Operator	`__setitem__()`	`__setitem__(self, arg0: slice, arg1: pyarts3.arts.ArrayOfSpeciesIsotope, /) -> None`
Operator	`__str__()`	`__str__(self) -> str`

Constructors

__init__(self) → None

__init__(self, arg: ArrayOfSpeciesIsotope) → None

__init__(self, arg: Iterable[SpeciesIsotope], /) → None

__init__(self) → None

__init__(self, arg: ArrayOfSpeciesIsotope) → None

Overloaded function.

__init__(self) -> None

Default constructor

__init__(self, arg: pyarts3.arts.ArrayOfSpeciesIsotope) -> None

Copy constructor

__init__(self, arg: collections.abc.Iterable[pyarts3.arts.SpeciesIsotope], /) -> None

Construct from an iterable object

__init__(self) -> None
__init__(self, arg: pyarts3.arts.ArrayOfSpeciesIsotope) -> None

Methods

append(self, arg: SpeciesIsotope, /) → None: Append arg to the end of the list.

appendxml(self, file: str) → str

Append variable from file.

The content of the file is added to the existing variable.

Parameters:: file (str) – A file that can be read.
Raises:: RuntimeError – For any failure to read.
Returns:: file – The file path found (may differ from input due to environment variables).
Return type:: str

clear(self) → None: Remove all items from list.

count(self, arg: SpeciesIsotope, /) → int: Return number of occurrences of arg.

extend(self, arg: ArrayOfSpeciesIsotope, /) → None: Extend self by appending elements from arg.

extendxml(self, file: str) → str

Extend variable from file.

The content of the file is added to the existing variable.

Parameters:: file (str) – A file that can be read.
Raises:: RuntimeError – For any failure to read.
Returns:: file – The file path found (may differ from input due to environment variables).
Return type:: str

insert(self, arg0: int, arg1: SpeciesIsotope, /) → None: Insert object arg1 before index arg0.

pop(self, index: int = -1) → SpeciesIsotope: Remove and return item at index (default last).

readxml(self, file: str) → str

Read variable from file.

Parameters:: file (str) – A file that can be read.
Raises:: RuntimeError – For any failure to read.
Returns:: file – The file path found (may differ from input due to environment variables).
Return type:: str

remove(self, arg: SpeciesIsotope, /) → None: Remove first occurrence of arg.

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → str

Saves variable to file.

Parameters:

file (str) – The path to which the file is written. Note that several of the options might modify the name or write more files.
type (str, optional) – Type of file to save. See FileType for options. Defaults is “ascii”.
clobber (bool, optional) – Overwrite existing files or add new file with modified name? Defaults is True.

Raises:

RuntimeError – For any failure to write.

Returns:

file – The file saved. May differ from input.

Return type:

str

Static Methods

fromxml(file: str) → ArrayOfSpeciesIsotope

Create variable from file.

Parameters:: file (str) – A file that can be read
Raises:: RuntimeError – For any failure to read.

fromxmls(files: ArrayOfString) → ArrayOfSpeciesIsotope

Create variable from file.

Like fromxml() but for split/multiple files.

Parameters:: files (list[str]) – A list of files that can be read
Raises:: RuntimeError – For any failure to read.

Operators

__contains__(self, arg: SpeciesIsotope, /) → bool
__contains__(self, arg: object, /) → bool

__delitem__(self, arg: int, /) → None
__delitem__(self, arg: slice, /) → None

__eq__(self, arg: object, /) → bool
__eq__(self, arg: ArrayOfSpeciesIsotope, /) → bool

__format__(self, arg: str, /) → str

__ge__(self, arg: ArrayOfSpeciesIsotope, /) → bool

__getitem__(self, arg: int, /) → SpeciesIsotope
__getitem__(self, arg: slice, /) → ArrayOfSpeciesIsotope

__gt__(self, arg: ArrayOfSpeciesIsotope, /) → bool

__hash__(): Return hash(self).

__init__(self) → None

__init__(self, arg: ArrayOfSpeciesIsotope) → None

__init__(self, arg: Iterable[SpeciesIsotope], /) → None

__init__(self) → None

__init__(self, arg: ArrayOfSpeciesIsotope) → None

Overloaded function.

__init__(self) -> None

Default constructor

__init__(self, arg: pyarts3.arts.ArrayOfSpeciesIsotope) -> None

Copy constructor

__init__(self, arg: collections.abc.Iterable[pyarts3.arts.SpeciesIsotope], /) -> None

Construct from an iterable object

__init__(self) -> None
__init__(self, arg: pyarts3.arts.ArrayOfSpeciesIsotope) -> None

__iter__(self) → Iterator[SpeciesIsotope]

__le__(self, arg: ArrayOfSpeciesIsotope, /) → bool

__len__(self) → int

__lt__(self, arg: ArrayOfSpeciesIsotope, /) → bool

__ne__(self, arg: object, /) → bool
__ne__(self, arg: ArrayOfSpeciesIsotope, /) → bool

__repr__(self) → str
__repr__(self) → str

__setitem__(self, arg0: int, arg1: SpeciesIsotope, /) → None
__setitem__(self, arg0: slice, arg1: ArrayOfSpeciesIsotope, /) → None

__str__(self) → str