SpeciesTag Class Reference

A tag group can consist of the sum of several of these. More...

#include <abs_species_tags.h>

List of all members.

Public Member Functions

SpeciesTag ()

Default constructor.

SpeciesTag (String def)

Constructor from a tag definition String.

String Name () const

Return the full name of the tag.

Index Species () const

Molecular species index.

Index Isotope () const

Isotopic species index.

Numeric Lf () const

The lower line center frequency in Hz.

Numeric Uf () const

The upper line center frequency in Hz: If this is <0 it means no upper limit.

bool operator== (const SpeciesTag &other) const

Comparison operator for species tags.

Private Attributes

Index mspecies

Molecular species index.

Index misotope

Isotopic species index.

Numeric mlf

The lower limit line center frequency in Hz.

Numeric muf

The upper line center frequency in Hz.

Detailed Description

A tag group can consist of the sum of several of these.

Author:: Stefan Buehler

Definition at line 45 of file abs_species_tags.h.

Constructor & Destructor Documentation

SpeciesTag::SpeciesTag ( ) [inline]

Default constructor.

Definition at line 48 of file abs_species_tags.h.

SpeciesTag::SpeciesTag ( String def )

Constructor from a tag definition String.

For examples see documentation of member function Name().

Parameters:

def

String containing tag definition.

Exceptions:

runtime_error

The given String could not be mapped to a sensible tag description.

Definition at line 47 of file abs_species_tags.cc.

References find_first(), SpeciesRecord::Isotope(), misotope, mlf, mspecies, muf, Array< base >::nelem(), my_basic_string< charT >::nelem(), my_basic_string< charT >::npos, species_data, and species_index_from_species_name().

Member Function Documentation

String SpeciesTag::Name ( ) const

Return the full name of the tag.

Examples:

  O3-*-*-*         : All O3 lines
  O3-nl            : O3, but without any lines
  O3-666-*-*       : All O3-666 lines
  O3-*-500e9-501e9 : All O3 lines between 500 and 501 GHz.

Returns:: The tag name as a string.

Definition at line 227 of file abs_species_tags.cc.

References SpeciesRecord::Isotope(), misotope, mlf, mspecies, muf, SpeciesRecord::Name(), Array< base >::nelem(), precision, and species_data.

Referenced by get_tag_group_index_for_tag_group(), get_tagindex_for_Strings(), operator<<(), and xml_write_to_stream().

Index SpeciesTag::Species ( ) const [inline]

Molecular species index.

Definition at line 61 of file abs_species_tags.h.

References mspecies.

Referenced by abs_lines_per_speciesCreateFromLines(), array_species_tag_from_string(), and find_next_species_tg().

Index SpeciesTag::Isotope ( ) const [inline]

Isotopic species index.

If this is equal to the number of isotopes (one more than allowed) it means all isotopes of this species.

Definition at line 66 of file abs_species_tags.h.

References misotope.

Referenced by abs_lines_per_speciesCreateFromLines().

Numeric SpeciesTag::Lf ( ) const [inline]

The lower line center frequency in Hz.

If this is <0 it means no lower limit.

Definition at line 70 of file abs_species_tags.h.

References mlf.

Referenced by abs_lines_per_speciesCreateFromLines().

Numeric SpeciesTag::Uf ( ) const [inline]

The upper line center frequency in Hz: If this is <0 it means no upper limit.

Definition at line 74 of file abs_species_tags.h.

References muf.

Referenced by abs_lines_per_speciesCreateFromLines().

bool SpeciesTag::operator== ( const SpeciesTag & other ) const [inline]

Comparison operator for species tags.

This returns false as soon as a singe discrepancy is detected. Otherwise it returns true at the end.

Parameters:

other

The other tag to compare to.

Returns:: true if the two tags are equal.

Author:: Stefan Buehler

Date:: 2002-11-29

Definition at line 88 of file abs_species_tags.h.

References misotope, mlf, mspecies, and muf.

Member Data Documentation

Index SpeciesTag::mspecies [private]

Molecular species index.

Definition at line 100 of file abs_species_tags.h.

Referenced by Name(), operator==(), Species(), species_index_from_species_name(), and SpeciesTag().

Index SpeciesTag::misotope [private]

Isotopic species index.

If this is equal to the number of isotopes (one more than allowed) it means all isotopes of this species. If it is <0 it means no isotope (no lines), corresponding to "H2O-nl"

Definition at line 107 of file abs_species_tags.h.

Referenced by Isotope(), Name(), operator==(), and SpeciesTag().

Numeric SpeciesTag::mlf [private]

The lower limit line center frequency in Hz.

If this is <0 it means no lower limit.

Definition at line 111 of file abs_species_tags.h.

Referenced by Lf(), Name(), operator==(), and SpeciesTag().

Numeric SpeciesTag::muf [private]

The upper line center frequency in Hz.

If this is <0 it means no upper limit.

Definition at line 115 of file abs_species_tags.h.

Referenced by Name(), operator==(), SpeciesTag(), and Uf().

The documentation for this class was generated from the following files:


Public Member Functions
	SpeciesTag ()
	Default constructor.
	SpeciesTag (String def)
	Constructor from a tag definition String.
String	Name () const
	Return the full name of the tag.
Index	Species () const
	Molecular species index.
Index	Isotope () const
	Isotopic species index.
Numeric	Lf () const
	The lower line center frequency in Hz.
Numeric	Uf () const
	The upper line center frequency in Hz: If this is <0 it means no upper limit.
bool	operator== (const SpeciesTag &other) const
	Comparison operator for species tags.
Private Attributes
Index	mspecies
	Molecular species index.
Index	misotope
	Isotopic species index.
Numeric	mlf
	The lower limit line center frequency in Hz.
Numeric	muf
	The upper line center frequency in Hz.