WsvRecord Class Reference

This class contains all static information for one workspace variable. More...

#include <wsv_aux.h>

Public Member Functions
	WsvRecord ()
	Default constructor. More...
	WsvRecord (const char name[], const char description[], const Index group)
	Initializing constructor. More...
const String &	Name () const
	Name of this workspace variable. More...
const String &	Description () const
	A text describing this workspace variable. More...
Index	Group () const
	The wsv group to which this variable belongs. More...

Private Attributes
String	mname
String	mdescription
Index	mgroup

Detailed Description

This class contains all static information for one workspace variable.

The program make_wsv_h.cc uses these records to generate the file wsv.h, which contains both the declaration of the wsv handles and the declaration of the workspace itself.

Author

Stefan Buehler

Definition at line 60 of file wsv_aux.h.

Constructor & Destructor Documentation

WsvRecord() [1/2]

WsvRecord::WsvRecord ( )

inline

Default constructor.

Definition at line 64 of file wsv_aux.h.

WsvRecord() [2/2]

WsvRecord::WsvRecord ( const char  name[], const char  description[], const Index  group  )

inline

Initializing constructor.

This is used by define_wsv_data() to set the information for each workspace variable.

Definition at line 70 of file wsv_aux.h.

Member Function Documentation

Description()

const String& WsvRecord::Description ( ) const

inline

A text describing this workspace variable.

Definition at line 82 of file wsv_aux.h.

Group()

Index WsvRecord::Group ( ) const

inline

The wsv group to which this variable belongs.

Definition at line 84 of file wsv_aux.h.

Name()

const String& WsvRecord::Name ( ) const

inline

Name of this workspace variable.

Definition at line 80 of file wsv_aux.h.

Member Data Documentation

mdescription

String WsvRecord::mdescription

private

Definition at line 87 of file wsv_aux.h.

mgroup

Index WsvRecord::mgroup

private

Definition at line 88 of file wsv_aux.h.

mname

String WsvRecord::mname

private

Definition at line 86 of file wsv_aux.h.

---

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

• wsv_aux.h