Odyssey::Script Class Reference

#include <Script.h>

List of all members.

Public Member Functions
void	setConfig (const Config &config)
	Sets the config for this script.
const Config &	getConfig () const
	Returns the currently set config.
virtual String	getType () const =0
	Returns a string type identifier for the script object.
virtual Script *	clone () const =0
	Clones the script.
virtual void	execute ()=0
	Executes the script.
virtual Any	_eval ()=0
	Internal method for evaluating the script.
Protected Member Functions
	Script ()
	Script (const Config &config)
Protected Attributes
Config	_config

---

Detailed Description

This class represents a non-C++ executable code block. It defers actual implementation of the execution to subclasses, but provides standard execution call definitions.

---

Constructor & Destructor Documentation

Odyssey::Script::Script (   )  [protected]

Odyssey::Script::Script (  const Config &  config  )  [protected]

---

Member Function Documentation

virtual Any Odyssey::Script::_eval (   )  [pure virtual]

Internal method for evaluating the script. This internal method is used to evaluate the script down to a specific returned value. This is to used with the templated eval free functions. See also: eval

virtual Script* Odyssey::Script::clone (   )  const [pure virtual]

Clones the script.

virtual void Odyssey::Script::execute (   )  [pure virtual]

Executes the script.

const Config& Odyssey::Script::getConfig (   )  const

Returns the currently set config.

virtual String Odyssey::Script::getType (   )  const [pure virtual]

Returns a string type identifier for the script object.

void Odyssey::Script::setConfig (  const Config &  config  )

Sets the config for this script. Sets the config stored with this script. Use of this config is implementation-specific, as well as what entries in a config might be useful or required. Parameters: config  the config to set

---

Member Data Documentation

Config Odyssey::Script::_config [protected]

---

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

• D:/Programs/odyssey/odyssey/include/Script.h

---