ARTS 2.5.9 (git: 825fa5f2)
AgRecord Class Reference

Lookup information for one agenda. More...

#include <agenda_record.h>

Public Member Functions

 AgRecord ()
 Default constructor. More...
 
 AgRecord (const char *name, const char *description, const ArrayOfString &output, const ArrayOfString &input)
 The only non-trivial constructor for AgRecord, which sets all the fields. More...
 
 AgRecord (const AgRecord &)=default
 
AgRecordoperator= (const AgRecord &)=default
 
const StringName () const
 
const StringDescription () const
 
const ArrayOfIndexOut () const
 
const ArrayOfIndexIn () const
 

Private Attributes

String mname
 The name of this agenda. More...
 
String mdescription
 A text string describing this agenda. More...
 
ArrayOfIndex moutput
 Workspace Output. More...
 
ArrayOfIndex minput
 Workspace Input. More...
 

Friends

ostream & operator<< (ostream &os, const AgRecord &agr)
 Output operator for AgRecord. More...
 

Detailed Description

Lookup information for one agenda.

An object of this class contains the documentation for an agenda, plus the list of output and input variables.

This cannot be set in the workspace lookup data, since we need to use the handles for the WSVs.

Definition at line 43 of file agenda_record.h.

Constructor & Destructor Documentation

◆ AgRecord() [1/3]

AgRecord::AgRecord ( )
inline

Default constructor.

Definition at line 46 of file agenda_record.h.

◆ AgRecord() [2/3]

AgRecord::AgRecord ( const char *  name,
const char *  description,
const ArrayOfString output,
const ArrayOfString input 
)

The only non-trivial constructor for AgRecord, which sets all the fields.

We work on the assumption, that the workspace lookup data has been defined before. So, what we have to do here is make sure that this agenda exists.

Parameters
nameAgenda name.
descriptionAgenda documentation.
outputList of output WSVs.
inputList of input WSVs.

Definition at line 56 of file agenda_record.cc.

References ARTS_USER_ERROR_IF, minput, mname, moutput, Array< base >::nelem(), and global_data::WsvMap.

◆ AgRecord() [3/3]

AgRecord::AgRecord ( const AgRecord )
default

Member Function Documentation

◆ Description()

const String & AgRecord::Description ( ) const
inline

Definition at line 60 of file agenda_record.h.

References mdescription.

◆ In()

◆ Name()

const String & AgRecord::Name ( ) const
inline

Definition at line 59 of file agenda_record.h.

References mname.

Referenced by main(), and write_agenda_wrapper_header().

◆ operator=()

AgRecord & AgRecord::operator= ( const AgRecord )
default

◆ Out()

Friends And Related Function Documentation

◆ operator<<

ostream & operator<< ( ostream &  os,
const AgRecord agr 
)
friend

Output operator for AgRecord.

Parameters
osOutput stream.
agrAgenda record.
Returns
Output stream.

Definition at line 188 of file agenda_record.cc.

Member Data Documentation

◆ mdescription

String AgRecord::mdescription
private

A text string describing this agenda.

Definition at line 71 of file agenda_record.h.

Referenced by Description().

◆ minput

ArrayOfIndex AgRecord::minput
private

Workspace Input.

Definition at line 77 of file agenda_record.h.

Referenced by AgRecord(), and In().

◆ mname

String AgRecord::mname
private

The name of this agenda.

Definition at line 68 of file agenda_record.h.

Referenced by AgRecord(), and Name().

◆ moutput

ArrayOfIndex AgRecord::moutput
private

Workspace Output.

Definition at line 74 of file agenda_record.h.

Referenced by AgRecord(), and Out().


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