SGStringParam Class Reference

String parameters. More...

#include <SGParameter.hpp>

Inheritance diagram for SGStringParam:

[legend]Collaboration diagram for SGStringParam:

[legend]List of all members.

Public Member Functions
char *	Value ()
	Returns the value of the parameter.
	SGStringParam (char *name, SGParam *tl, char *default_str=NULL)
	Constructor.
virtual	~SGStringParam ()
	Destructor.
Static Public Attributes
static char	TypeId [] = "s"
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

String parameters.

---

Constructor & Destructor Documentation

SGStringParam::SGStringParam	(	char *	name,
		SGParam *	tl,
		char *	default_str = NULL
	)			[inline]

Constructor.

Parameters:

[in]	name	The name of the parameter
[in]	tl	The next parameter in the list
[in]	default_str	The default value

virtual SGStringParam::~SGStringParam

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

void SGStringParam::read_param

(

)

[protected, virtual]

Reads a value of the parameter from the input stream.

Implements SGParam.

void SGStringParam::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.

char* SGStringParam::Value

(

)

[inline]

Returns the value of the parameter.

---

Member Data Documentation

char SGStringParam::TypeId = "s" [static]

---

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

• SGParameter.hpp
• SGParameter.cpp

---