falaise Namespace Reference

Namespaces
	app
	common
	config
	detail
	processing
	tags

Classes
class	ResourceInitializationException
	Exception class for bad resource initialization. More...
class	UnknownResourceException
	Exception class for unknown resources. More...
struct	version
	Describe the falaise API version and features. More...

Enumerations
enum	exit_code { EXIT_OK = 0, EXIT_USAGE = 64, EXIT_UNAVAILABLE = 69 }
	enumerator holding exit code values More...

Functions
void	initialize (int argc_=0, char *argv_[]=0, uint32_t flags_=0)
	Initialize resources of the Falaise library. More...
void	terminate ()
	Terminate resources of the Falaise library. More...
void	init_resources ()
std::string	get_resource_dir ()
	Return URL, i.e. a path, to the base directory where resource files are installed. More...
std::string	get_resource (const std::string &rname)
	Return URL, i.e. a path, to named resource. More...
std::string	get_plugin_dir ()
	//! Return URL, i.e. a path, to the base directory where plugin DLL files are installed More...
std::string	get_plugin (const std::string &rname)
	Return URL, i.e. a path, to named resource. More...

Enumeration Type Documentation

exit_code

enum falaise::exit_code

enumerator holding exit code values

Enumerator
EXIT_OK	Successful termination.
EXIT_USAGE	Usage error, e.g. incorrect command line.
EXIT_UNAVAILABLE	Service unavailable.

Function Documentation

get_plugin()

std::string falaise::get_plugin

(

const std::string &

rname

)

Return URL, i.e. a path, to named resource.

get_plugin_dir()

std::string falaise::get_plugin_dir

(

)

//! Return URL, i.e. a path, to the base directory where plugin DLL files are installed

get_resource()

std::string falaise::get_resource

(

const std::string &

rname

)

Return URL, i.e. a path, to named resource.

get_resource_dir()

std::string falaise::get_resource_dir

(

)

Return URL, i.e. a path, to the base directory where resource files are installed.

init_resources()

void falaise::init_resources

(

)

Initialize the library resource paths

Exceptions

ResourceInitializationException

when library cannot self locate

initialize()

void falaise::initialize	(	int	argc_ = 0,
		char *	argv_[] = 0,
		uint32_t	flags_ = 0
	)

Initialize resources of the Falaise library.

terminate()

void falaise::terminate

(

)

Terminate resources of the Falaise library.