SpeciesEnumPair

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

Contains a pair of SpeciesEnum

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`SpeciesEnum`	`spec1`	First species
`SpeciesEnum`	`spec2`	Second species
Operator	`__eq__()`	__eq__(self, arg: pyarts3.arts.SpeciesEnumPair, /) -> bool
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	__ge__(self, arg: pyarts3.arts.SpeciesEnumPair, /) -> bool
Operator	`__gt__()`	__gt__(self, arg: pyarts3.arts.SpeciesEnumPair, /) -> bool
Operator	`__hash__()`	__hash__(self) -> int
Operator	`__init__()`	Overloaded function.
Operator	`__le__()`	__le__(self, arg: pyarts3.arts.SpeciesEnumPair, /) -> bool
Operator	`__lt__()`	__lt__(self, arg: pyarts3.arts.SpeciesEnumPair, /) -> bool
Operator	`__ne__()`	__ne__(self, arg: pyarts3.arts.SpeciesEnumPair, /) -> bool
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self) → None

__init__(self, arg: pyarts3.arts.SpeciesEnumPair) → None

__init__(self, spec1: pyarts3.arts.SpeciesEnum, spec2: pyarts3.arts.SpeciesEnum) → None

__init__(self, s: str) → None

Overloaded function.

__init__(self) -> None
__init__(self, arg: pyarts3.arts.SpeciesEnumPair) -> None
__init__(self, spec1: pyarts3.arts.SpeciesEnum, spec2: pyarts3.arts.SpeciesEnum) -> None

Create a species pair from two species

__init__(self, s: str) -> None

Create a species pair from string ‘SpeciesA-SpeciesB’

Methods

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

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) → pyarts3.arts.SpeciesEnumPair

Create variable from file.

Parameters:: file (str) – A file that can be read
Raises:: RuntimeError – For any failure to read.
Returns:: artstype – The variable created from the file.
Return type:: T

Attributes

spec1: SpeciesEnum: First species .. SpeciesEnum

spec2: SpeciesEnum: Second species .. SpeciesEnum

Operators

__eq__(self, arg: pyarts3.arts.SpeciesEnumPair, /) → bool
__eq__(self, arg: pyarts3.arts.SpeciesEnumPair, /) → bool

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

__ge__(self, arg: pyarts3.arts.SpeciesEnumPair, /) → bool

__gt__(self, arg: pyarts3.arts.SpeciesEnumPair, /) → bool

__hash__(self) → int

__init__(self) → None