green::VariableTableTemplate Class Reference

#include <VariableTableTemplate.h>

Inheritance diagram for green::VariableTableTemplate:

List of all members.

Public Member Functions
virtual	~VariableTableTemplate ()
InitFormatPtr	GetInitFormat () const
void	SetInitFormat (InitFormatPtr format)
Key	AddEntry (const Name &name, Variable::Type type, Variable::Value value)
virtual void	Print (std::ostream &os)
Protected Attributes
InitFormatPtr	mInitFormat

---

Detailed Description

This class represents a template for a table of variables. Basically, it associates a name or Key to a variable type. VariableTableInstance objects implement specific instances of these templates, and contain the actual values associated with these variables.

---

Constructor & Destructor Documentation

virtual green::VariableTableTemplate::~VariableTableTemplate

(

)

[inline, virtual]

Default destructor, declared virtual.

---

Member Function Documentation

InitFormatPtr green::VariableTableTemplate::GetInitFormat

(

)

const [inline]

Get the initializer list format for this template.

Returns:

Returns the initializer list format.

void green::VariableTableTemplate::SetInitFormat

(

InitFormatPtr

format

)

[inline]

Set the initializer list format for this template.

Parameters:

format

The new format for this template.

Key green::VariableTableTemplate::AddEntry	(	const Name &	name,
		Variable::Type	type,
		Variable::Value	value
	)			[inline]

A convenience function for adding a variable template

Parameters:

	name	The name of the variable
	type	The type of the variable
	defaultValue	The default value of the variable

Returns:

Returns the Key for the new variable

virtual void green::VariableTableTemplate::Print

(

std::ostream &

os

)

[inline, virtual]

A nice Print function to print the contents of the table

Parameters:

os

The output ostream to print to.

Reimplemented in green::BehaviorTemplate, and green::EntityTemplate.

---

Member Data Documentation

InitFormatPtr green::VariableTableTemplate::mInitFormat [protected]

This is the initializer list format

---

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

• src/engine/VariableTableTemplate.h

---