sp::io Namespace Reference

All simple text output and string class are in this namespace. More...

Namespaces
namespace	Log
	Log class has been changed to an own namespace. The syntax remains the same but now you can use "using namespace io::Log;".
Classes
class	AssetContainer
class	DefaultException
	Default exception holding a message describing the error. More...
class	RenderSystemException
	Render-system-exceptions will be thrown when an object is going to be instantiated before the global render system has been created. More...
class	NullPointerException
	Null-pointer-exceptions will be thrown when an invalid object (or rather a null pointer) is passed to a class constructor which requires a valid object. More...
class	BaseFileFormatHandler
	Base loader class. Base class for scene::MeshLoader, video::ImageLoader and sound::SoundLoader. More...
class	File
	File base class. More...
class	FilePhysical
class	FileSystem
class	FileVirtual
class	OSInformator
class	string
	Basic string class. This class wraps the std::string to have better string access. More...
struct	SFrequenceQuery
class	Timer
class	XBox360GamePad
Typedefs
typedef string< c8 >	stringc
typedef string< c16 >	stringw
typedef boost::shared_ptr < XBox360GamePad >	XBox360GamePadPtr
	XBox 360 gamepad shared pointer type.
typedef boost::function< void(const XBox360GamePad &Controller)>	XBoxGamePadConnectCallback
	XBox 360 gamepad connection callback type.
Enumerations
enum	EFileSeekTypes { FILEPOS_BEGIN = SEEK_SET, FILEPOS_CURRENT = SEEK_CUR, FILEPOS_END = SEEK_END }
	File seek positions. More...
enum	EFilePermission {   FILE_UNDEFINED, FILE_READ, FILE_WRITE, FILE_WRITE_APPEND,   FILE_READWRITE, FILE_READWRITE_APPEND }
	File access permissions. More...
enum	EFileTypes { FILE_PHYSICAL, FILE_VIRTUAL, FILE_ASSET }
	File object types. More...
enum	EResourceConfigs { RESOURCE_PHYSICAL, RESOURCE_ASSET }
enum	ELogTimeFormats { LOGTIME_DISABLE, LOGTIME_HHMMSS, LOGTIME_MILLISECS }
	Log message time information formats. More...
enum	ELogMessageFlags {   LOG_MSGBOX = 0x01, LOG_TIME = 0x02, LOG_WARNING = 0x04, LOG_ERROR = 0x08,   LOG_DEBUG = 0x10, LOG_NONEWLINE = 0x20, LOG_NOTAB = 0x40 }
	Flags for printed log messages. More...
enum	ELogOutputContexts { LOGCONTEXT_NONE = 0x00, LOGCONTEXT_CONSOLE = 0x01, LOGCONTEXT_FILE = 0x02 }
	Log output contexts for runtime debugging. More...
enum	EMemorySizeTypes {   MEMORYSIZE_BYTE = 0, MEMORYSIZE_KB, MEMORYSIZE_MB, MEMORYSIZE_GB,   MEMORYSIZE_TB }
	Memroy size (or rather dimension) types. More...
enum	ETimeTypes {   TIME_SECOND = 0, TIME_MINUTE, TIME_HOUR, TIME_DAY,   TIME_MONTH, TIME_YEAR }
	Types of time. More...
Functions
template<typename T >
stringc	getHexString (const T &Number)
	Converts the specified humber into a hex value as string (e.g. 256 -> "FF").
template<typename T >
T	getHexNumber (const io::stringc &Str)
template<typename T >
string< T >	operator+ (const c8 *cStr, const string< T > &spStr)
template<class T , template< class TL, class Allocator=std::allocator< TL > > class L>
void	getListFromString (const stringc &Str, L< T > &List, s32 MaxCount=-1)
	Stores all values separated by the ';' character in the specified string in the output list (e.g. "1;2;3;" -> { 1, 2, 3 }).
template<class T >
void	getListFromString (const stringc &Str, std::vector< T > &List, s32 MaxCount=-1)
template<class T >
void	getListFromString (const stringc &Str, std::list< T > &List, s32 MaxCount=-1)

---

Detailed Description

All simple text output and string class are in this namespace.

---

Typedef Documentation

typedef string<c8> sp::io::stringc

typedef string<c16> sp::io::stringw

typedef boost::shared_ptr<XBox360GamePad> sp::io::XBox360GamePadPtr

XBox 360 gamepad shared pointer type.

typedef boost::function<void (const XBox360GamePad &Controller)> sp::io::XBoxGamePadConnectCallback

XBox 360 gamepad connection callback type.

---

Enumeration Type Documentation

enum sp::io::EFilePermission

File access permissions.

Enumerator:

FILE_UNDEFINED	Undefined permission when the file is not opened yet.
FILE_READ	Only read access.
FILE_WRITE	Only write access.
FILE_WRITE_APPEND	Only write access. Previous content will be retained.
FILE_READWRITE	Read- and write access.
FILE_READWRITE_APPEND	Read- and write access. Previous content will be retained.

enum sp::io::EFileSeekTypes

File seek positions.

Enumerator:

FILEPOS_BEGIN
FILEPOS_CURRENT
FILEPOS_END

enum sp::io::EFileTypes

File object types.

Enumerator:

FILE_PHYSICAL	Physical file stored on a HDD, SSD or Flash-Drive.
FILE_VIRTUAL	Virtual file stored in RAM only.
FILE_ASSET	Resource file with read access only for Android.

enum sp::io::ELogMessageFlags

Flags for printed log messages.

Enumerator:

LOG_MSGBOX	Use a message box.
LOG_TIME	Print time (e.g. "[18:30:12] ...").
LOG_WARNING	Yellow color like a warning message.
LOG_ERROR	Red color like an error message.
LOG_DEBUG	Pink color like a debug message.
LOG_NONEWLINE	No new line will be printed.
LOG_NOTAB	No tab string is printed.

enum sp::io::ELogOutputContexts

Log output contexts for runtime debugging.

Enumerator:

LOGCONTEXT_NONE	No log information will be printed.
LOGCONTEXT_CONSOLE	Log information will be printed in the console.
LOGCONTEXT_FILE	Log information will be printed in the debug file.

enum sp::io::ELogTimeFormats

Log message time information formats.

Enumerator:

LOGTIME_DISABLE	No time is printed to any log message.
LOGTIME_HHMMSS	Current time is printed to every log message in the format [HH:MM:SS.] (e.g. "[18:30:12]").
LOGTIME_MILLISECS	Current time is printed to every log message in the format [M] where M are the milliseconds since program start (e.g. "[139758]").

enum sp::io::EMemorySizeTypes

Memroy size (or rather dimension) types.

Enumerator:

MEMORYSIZE_BYTE	Byte.
MEMORYSIZE_KB	Kilo byte (KB).
MEMORYSIZE_MB	Mega byte (MB).
MEMORYSIZE_GB	Giga byte (GB).
MEMORYSIZE_TB	Tera byte (TB).

enum sp::io::EResourceConfigs

Enumerator:

RESOURCE_PHYSICAL	Resource files will be read from HDD, SSD or Flash-Drive.
RESOURCE_ASSET	Resource files will be read from assets (only for Android).

enum sp::io::ETimeTypes

Types of time.

Enumerator:

TIME_SECOND
TIME_MINUTE
TIME_HOUR
TIME_DAY
TIME_MONTH
TIME_YEAR

---

Function Documentation

template<typename T >

T sp::io::getHexNumber

(

const io::stringc &

Str

)

template<typename T >

stringc sp::io::getHexString

(

const T &

Number

)

Converts the specified humber into a hex value as string (e.g. 256 -> "FF").

template<class T >

void sp::io::getListFromString	(	const stringc &	Str,
		std::vector< T > &	List,
		s32	MaxCount = -1
	)

template<class T , template< class TL, class Allocator=std::allocator< TL > > class L>

void sp::io::getListFromString	(	const stringc &	Str,
		L< T > &	List,
		s32	MaxCount = -1
	)

Stores all values separated by the ';' character in the specified string in the output list (e.g. "1;2;3;" -> { 1, 2, 3 }).

template<class T >

void sp::io::getListFromString	(	const stringc &	Str,
		std::list< T > &	List,
		s32	MaxCount = -1
	)

template<typename T >

string<T> sp::io::operator+	(	const c8 *	cStr,
		const string< T > &	spStr
	)