SGRVectorParam Class Reference

Small double-vector parameter. More...

#include <SGParameter.hpp>

Inheritance diagram for SGRVectorParam:

[legend]Collaboration diagram for SGRVectorParam:

[legend]List of all members.

Public Member Functions
	SGRVectorParam (char *name, SGParam *tl, bool hdv=0)
	Constructor.
virtual	~SGRVectorParam ()
	Virtual destructor.
Static Public Attributes
static char	TypeId [] = "Vr"
Protected Member Functions
void	read_param ()
	Reads a value of the parameter from the input stream.
void	print_param (std::ostream &s, short indent)
	Prints the name and the value of the parameter with a given indent.

---

Detailed Description

Small double-vector parameter.

Syntax:
<name> [=] [<r_1>, ..., <r_N>];
The length N of the array is not predefined and is specified in the input file by the number of the entries.

Note:

1. There can be no default value for the vector. If the parameter
   has not been specified at all, but the 'default initialization'
   flag is set then the vector has the zero size. The user should
   check this.
2. The construction
   <name> [=] [];
   is NOT allowed. At least one entry should be specified.
3. Use the normal small_vector<double>-operations to work with
   the parameter.

---

Constructor & Destructor Documentation

SGRVectorParam::SGRVectorParam	(	char *	name,
		SGParam *	tl,
		bool	hdv = 0
	)			[inline]

Constructor.

Parameters:

[in]	name	The name of the parameter
[in]	tl	The next parameter in the list
[in]	hdv	non-zero to suppress the error if not set explicitly

virtual SGRVectorParam::~SGRVectorParam

(

)

[inline, virtual]

Virtual destructor.

---

Member Function Documentation

void SGRVectorParam::read_param

(

)

[protected, virtual]

Reads a value of the parameter from the input stream.

Implements SGParam.

void SGRVectorParam::print_param	(	std::ostream &	s,
		short	indent
	)			[protected, virtual]

Prints the name and the value of the parameter with a given indent.

Parameters:

[in]	s	The stream to print to
[in]	indent	The indent for the output lines

Implements SGParam.

---

Member Data Documentation

char SGRVectorParam::TypeId = "Vr" [static]

---

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

• SGParameter.hpp
• SGParameter.cpp

---