MdRecord Class Reference

This class contains all information for one workspace method. More...

#include <methods.h>

Public Member Functions
	MdRecord ()
	Default constructor. More...
	MdRecord (const char name[], const char description[], const MakeArray< Index > &output, const MakeArray< Index > &input, const MakeArray< Index > &goutput, const MakeArray< Index > &ginput, const MakeArray< String > &keywords, const MakeArray< TokValType > &types)
	The only non-trivial constructor, which sets all the fields. More...
const String &	Name () const
const String &	Description () const
const ArrayOfIndex &	Output () const
const ArrayOfIndex &	Input () const
const ArrayOfIndex &	GOutput () const
const ArrayOfIndex &	GInput () const
const Array< String > &	Keywords () const
const Array< TokValType > &	Types () const
ostream &	PrintTemplate (ostream &os, bool show_description=true) const
	Print method template for the control file. More...
MdRecord	operator= (const MdRecord &)
	To override the default assignment operator. More...

Private Attributes
String	mname
	The name of this method. More...
String	mdescription
	A text string describing this method. More...
ArrayOfIndex	moutput
	Workspace Output. More...
ArrayOfIndex	minput
	Workspace Input. More...
ArrayOfIndex	mgoutput
	Generic Workspace Output. More...
ArrayOfIndex	mginput
	Generic Workspace Input. More...
ArrayOfString	mkeywords
	Keywords. More...
Array< TokValType >	mtypes
	Types associated with keywords. More...

Detailed Description

This class contains all information for one workspace method.

Definition at line 35 of file methods.h.

Constructor & Destructor Documentation

MdRecord() [1/2]

MdRecord::MdRecord ( )

inline

Default constructor.

Definition at line 39 of file methods.h.

MdRecord() [2/2]

MdRecord::MdRecord ( const char  name[], const char  description[], const MakeArray< Index > &  output, const MakeArray< Index > &  input, const MakeArray< Index > &  goutput, const MakeArray< Index > &  ginput, const MakeArray< String > &  keywords, const MakeArray< TokValType > &  types  )

inline

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

Definition at line 52 of file methods.h.

Member Function Documentation

Description()

const String& MdRecord::Description ( ) const

inline

Definition at line 79 of file methods.h.

GInput()

const ArrayOfIndex& MdRecord::GInput ( ) const

inline

Definition at line 83 of file methods.h.

GOutput()

const ArrayOfIndex& MdRecord::GOutput ( ) const

inline

Definition at line 82 of file methods.h.

Input()

const ArrayOfIndex& MdRecord::Input ( ) const

inline

Definition at line 81 of file methods.h.

Keywords()

const Array<String>& MdRecord::Keywords ( ) const

inline

Definition at line 84 of file methods.h.

Name()

const String& MdRecord::Name ( ) const

inline

Definition at line 78 of file methods.h.

operator=()

MdRecord MdRecord::operator= ( const MdRecord &  )

inline

To override the default assignment operator.

MdRecords cannot be assigned!

Definition at line 98 of file methods.h.

Output()

const ArrayOfIndex& MdRecord::Output ( ) const

inline

Definition at line 80 of file methods.h.

PrintTemplate()

ostream & MdRecord::PrintTemplate	(	ostream &	os,
		bool	show_description = true
	)		const

Print method template for the control file.

This prints the method data exactly in the same way how it can be included in the control file. The description string is also printed as a comment, but this can be turned off by setting show_comment to false.

Parameters

show_description

Should the description string also be printed?

Definition at line 49 of file methods_aux.cc.

Types()

const Array<TokValType>& MdRecord::Types ( ) const

inline

Definition at line 85 of file methods.h.

Member Data Documentation

mdescription

String MdRecord::mdescription

private

A text string describing this method.

Definition at line 108 of file methods.h.

mginput

ArrayOfIndex MdRecord::mginput

private

Generic Workspace Input.

Definition at line 120 of file methods.h.

mgoutput

ArrayOfIndex MdRecord::mgoutput

private

Generic Workspace Output.

Definition at line 117 of file methods.h.

minput

ArrayOfIndex MdRecord::minput

private

Workspace Input.

Definition at line 114 of file methods.h.

mkeywords

ArrayOfString MdRecord::mkeywords

private

Keywords.

Definition at line 123 of file methods.h.

mname

String MdRecord::mname

private

The name of this method.

Definition at line 105 of file methods.h.

moutput

ArrayOfIndex MdRecord::moutput

private

Workspace Output.

Definition at line 111 of file methods.h.

mtypes

Array<TokValType> MdRecord::mtypes

private

Types associated with keywords.

Definition at line 126 of file methods.h.

---

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

• methods.h
• methods_aux.cc