SGBoolParam Class Reference

Boolean parameters. More...

#include <SGParameter.hpp>

Inheritance diagram for SGBoolParam:

[legend]Collaboration diagram for SGBoolParam:

[legend]List of all members.

Public Member Functions
bool	Value ()
	Returns the value of the parameter.
	SGBoolParam (char *name, SGParam *tl)
	Constructor, no default value.
	SGBoolParam (char *name, SGParam *tl, bool v)
	Constructor, with a default value.
Static Public Attributes
static char	TypeId [] = "b"
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

Boolean parameters.

---

Constructor & Destructor Documentation

SGBoolParam::SGBoolParam	(	char *	name,
		SGParam *	tl
	)			[inline]

Constructor, no default value.

Parameters:

[in]	name	The name of the parameter
[in]	tl	The next parameter in the list

SGBoolParam::SGBoolParam	(	char *	name,
		SGParam *	tl,
		bool	v
	)			[inline]

Constructor, with a default value.

Parameters:

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

---

Member Function Documentation

void SGBoolParam::read_param

(

)

[protected, virtual]

Reads a value of the parameter from the input stream.

Implements SGParam.

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

bool SGBoolParam::Value

(

)

[inline]

Returns the value of the parameter.

---

Member Data Documentation

char SGBoolParam::TypeId = "b" [static]

---

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

• SGParameter.hpp
• SGParameter.cpp

---