ArrayOfAgenda

class pyarts.arts.ArrayOfAgenda(*args, **kwargs)

A list of Agenda

Overview

Method

append()

Append arg to the end of the list.

Method

clear()

Remove all items from list.

Method

extend()

Extend self by appending elements from arg.

Method

finalize()

Checks if the agenda works

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

savexml()

Saves variable to file

Static Method

fromxml()

Create variable from file

Attribute

name

String Name of the array of agenda

Operator

__delitem__()

__delitem__(self, arg: slice, /) -> None

Operator

__eq__()

Return self==value.

Operator

__ge__()

Return self>=value.

Operator

__getitem__()

__getitem__(self, arg: slice, /) -> pyarts.arts.ArrayOfAgenda

Operator

__gt__()

Return self>value.

Operator

__hash__()

Return hash(self).

Operator

__iter__()

__iter__(self) -> collections.abc.Iterator[pyarts.arts.Agenda]

Operator

__le__()

Return self<=value.

Operator

__len__()

__len__(self) -> int

Operator

__lt__()

Return self<value.

Operator

__ne__()

Return self!=value.

Operator

__setitem__()

__setitem__(self, arg0: slice, arg1: pyarts.arts.ArrayOfAgenda, /) -> None

Constructors

__init__(self) None
__init__(self, arg: pyarts.arts.ArrayOfAgenda) None
__init__(self, arg: collections.abc.Iterable[pyarts.arts.Agenda], /) None
__init__(self) None
__init__(self, arg: pyarts.arts.ArrayOfAgenda) None
__init__(self, arg: pyarts.arts.ArrayOfAgenda) None

Overloaded function.

  1. __init__(self) -> None

Default constructor

  1. __init__(self, arg: pyarts.arts.ArrayOfAgenda) -> None

Copy constructor

  1. __init__(self, arg: collections.abc.Iterable[pyarts.arts.Agenda], /) -> None

Construct from an iterable object

  1. __init__(self, arg: pyarts.arts.ArrayOfAgenda) -> None

Create from list

Methods

append(self, arg: pyarts.arts.Agenda, /) None

Append arg to the end of the list.

clear(self) None

Remove all items from list.

extend(self, arg: pyarts.arts.ArrayOfAgenda, /) None

Extend self by appending elements from arg.

finalize(self) None

Checks if the agenda works

insert(self, arg0: int, arg1: pyarts.arts.Agenda, /) None

Insert object arg1 before index arg0.

pop(self, index: int = -1) pyarts.arts.Agenda

Remove and return item at index (default last).

readxml(self, file: str) None

Read variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

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

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) – Type of file to save (ascii. zascii, or binary)

  • clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:

Throws RuntimeError for any failure to save

Static Methods

fromxml(file: str) pyarts.arts.ArrayOfAgenda

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

name

String Name of the array of agenda

Operators

__delitem__(self, arg: int, /) None
__delitem__(self, arg: slice, /) None
__eq__(value, /)

Return self==value.

__ge__(value, /)

Return self>=value.

__getitem__(self, arg: int, /) pyarts.arts.Agenda
__getitem__(self, arg: slice, /) pyarts.arts.ArrayOfAgenda
__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__iter__(self) collections.abc.Iterator[pyarts.arts.Agenda]
__le__(value, /)

Return self<=value.

__len__(self) int
__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__setitem__(self, arg0: int, arg1: pyarts.arts.Agenda, /) None
__setitem__(self, arg0: slice, arg1: pyarts.arts.ArrayOfAgenda, /) None