#include <Resource.h>

Inheritance diagram for Resource:

Public Member Functions
	Resource (const std::string &filePath)
	Resource ()
virtual	~Resource ()
const std::string &	getName () const
const std::string &	getErrorMessage () const
const Uint	getID () const
bool	isLoaded () const
Protected Attributes
std::string	mResourceName
std::string	mErrorDescription
bool	mIsLoaded
Private Member Functions
virtual void	load ()=0
Private Attributes
Uint	mGUID

Detailed Description

A basic Resource.

A base Resource class from which all other resources are derived. Provides the basic framework for Resources to load and initialize themselves.

Can be used with or without a ResourceManager however it is recommended that a ResourceManager be used.

Constructor & Destructor Documentation

Resource::Resource ( const std::string & filePath )

Resource::Resource ( )

Default Constructor.

virtual Resource::~Resource ( ) [inline, virtual]

const std::string& Resource::getErrorMessage ( ) const [inline]

Returns the last error message.

const Uint Resource::getID ( ) const [inline]

Returns the GUID of this Resource.

const std::string& Resource::getName ( ) const [inline]

Returns the name of the Resource as a file name with directory path.

bool Resource::isLoaded ( ) const [inline]

Returns true if this Resource loaded properly.

virtual void Resource::load ( ) [private, pure virtual]

Performs the necessary operations to load a Resource.

Note:: This is a pure virtual function and so must be overridden by all derived classes.; It is the responsibility of the derived class to call this function.

Implemented in Font, Image, Music, Skin, and Sound.