orxonox::Loader Class Reference

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/core/Loader.h>

Inheritance diagram for orxonox::Loader:

Public Member Functions
bool	load (const XMLFile *file, const ClassTreeMask &mask=ClassTreeMask(), bool bVerbose=true, bool bRemoveLuaTags=false)
	Loads the input file, while conforming to the restrictions given by the input ClassTreeMask. More...
void	unload (const XMLFile *file, const ClassTreeMask &mask=ClassTreeMask())

Static Public Member Functions
static std::string	removeLuaTags (const std::string &text)
static std::string	replaceLuaTags (const std::string &text)
Static Public Member Functions inherited from orxonox::Singleton< Loader >
static bool	exists ()
	Tells whether the singleton has been created. More...
static Loader &	getInstance ()
	Returns a reference to the singleton instance. More...

Public Attributes
ClassTreeMask	currentMask_

Static Private Member Functions
static bool	getLuaTags (const std::string &text, std::map< size_t, bool > &luaTags)

Private Attributes
std::vector< std::pair< const XMLFile *, ClassTreeMask > >	files_

Static Private Attributes
static Loader *	singletonPtr_s = nullptr

Friends
class	Singleton< Loader >

Additional Inherited Members
Protected Member Functions inherited from orxonox::Singleton< Loader >
	Singleton ()
	Constructor sets the singleton instance pointer. More...
virtual	~Singleton ()
	Destructor resets the singleton instance pointer. More...

Member Function Documentation

bool orxonox::Loader::getLuaTags ( const std::string &  text, std::map< size_t, bool > &  luaTags  )

staticprivate

bool orxonox::Loader::load	(	const XMLFile *	file,
		const ClassTreeMask &	mask = ClassTreeMask(),
		bool	bVerbose = true,
		bool	bRemoveLuaTags = false
	)

Loads the input file, while conforming to the restrictions given by the input ClassTreeMask.

Parameters

file	The file to be loaded.
mask	A ClassTreeMask, which defines which types of classes are loaded and which aren't.
bVerbose	Whether the loader is verbose (prints its progress in a low output level) or not.
bRemoveLuaTags	If true lua tags are just ignored and removed. The default is false.

Returns

Returns true if successful.

std::string orxonox::Loader::removeLuaTags ( const std::string &  text )

static

std::string orxonox::Loader::replaceLuaTags ( const std::string &  text )

static

void orxonox::Loader::unload	(	const XMLFile *	file,
		const ClassTreeMask &	mask = ClassTreeMask()
	)

Friends And Related Function Documentation

friend class Singleton< Loader >

friend

Member Data Documentation

ClassTreeMask orxonox::Loader::currentMask_

std::vector<std::pair<const XMLFile*, ClassTreeMask> > orxonox::Loader::files_

private

Loader * orxonox::Loader::singletonPtr_s = nullptr

staticprivate

---

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

• libraries/core/Loader.h
• libraries/core/Loader.cc