SGIntArrayParam Class Reference

Parameter of the type "Array of integers". More...

#include <SGParameter.hpp>

Inheritance diagram for SGIntArrayParam:

[legend]Collaboration diagram for SGIntArrayParam:

[legend]List of all members.

Public Member Functions
	SGIntArrayParam (char *name, SGParam *tl, bool hdv=0)
	Constructor.
virtual	~SGIntArrayParam ()
	Virtual destructor.
Static Public Attributes
static char	TypeId [] = "Ai"
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

Parameter of the type "Array of integers".

Syntax:
<name> [=] (<i_1>, ..., <i_N>);

The length N of the array is not predefined and is specified in the input file by the number of the integers.

Note:

1. There can be no default value for the array. If the parameter
   has not been specified at all, but the 'default initialization'
   flag is set then the array has the zero length. The user should
   check this.
2. The construction
   <name> [=] ();
   is NOT allowed. The user should specify at least one entry.
3. Use the normal Array<int>-operations to access the entries
   of the parameter. Besides, you may use the parameter as a
   MultiIndex.

---

Constructor & Destructor Documentation

SGIntArrayParam::SGIntArrayParam	(	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 SGIntArrayParam::~SGIntArrayParam

(

)

[inline, virtual]

Virtual destructor.

---

Member Function Documentation

void SGIntArrayParam::read_param

(

)

[protected, virtual]

Reads a value of the parameter from the input stream.

Implements SGParam.

void SGIntArrayParam::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 SGIntArrayParam::TypeId = "Ai" [static]

---

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

• SGParameter.hpp
• SGParameter.cpp

---