Global helper functions


Functions

void _NRExport nrEngine::sleep (uint32 milliseconds)
std::string _NRExport nrEngine::convertVersionToString (uint32 version)
uint32 _NRExport nrEngine::createVersionInteger (uint8 major, uint8 minor, uint8 patch)
std::string _NRExport nrEngine::trim (const std::string &str)
std::string _NRExport nrEngine::orderToString (int32 order)

Detailed Description

This group defines some usefull functions, macros and classes which are helpfull by the work with the engine.

Function Documentation

std::string nrEngine::convertVersionToString ( uint32  version  ) 

Convert a given version integer into a understandable string which have a form like x.x.x

Parameters:
version Version integer build by NR_createVersionInteger

Definition at line 57 of file StdHelpers.cpp.

Referenced by nrEngine::Plugin::initialize(), and nrEngine::Engine::initializeEngine().

uint32 nrEngine::createVersionInteger ( uint8  major,
uint8  minor,
uint8  patch 
)

Create an version integer from major, minor, patch numbers.

Parameters:
major,minor,patch 8 Bit long version number parts

Definition at line 78 of file StdHelpers.cpp.

std::string _NRExport nrEngine::orderToString ( int32  order  ) 

Convert a given order name into a readable string

Definition at line 99 of file StdHelpers.cpp.

References nrEngine::ORDER_FIRST, nrEngine::ORDER_HIGH, nrEngine::ORDER_LAST, nrEngine::ORDER_LOW, nrEngine::ORDER_NORMAL, nrEngine::ORDER_SYS_FIRST, nrEngine::ORDER_SYS_FIVETH, nrEngine::ORDER_SYS_FOURTH, nrEngine::ORDER_SYS_LAST, nrEngine::ORDER_SYS_ROOT, nrEngine::ORDER_SYS_SECOND, nrEngine::ORDER_SYS_THIRD, nrEngine::ORDER_ULTRA_HIGH, nrEngine::ORDER_ULTRA_LOW, nrEngine::ORDER_VERY_HIGH, and nrEngine::ORDER_VERY_LOW.

Referenced by nrEngine::Kernel::AddTask().

void nrEngine::sleep ( uint32  milliseconds  ) 

NR_sleep do a sleep for a given count of milliseconds. The sleeping function is defined to be platform independent, so you are able to use it on every platform.

Parameters:
milliseconds Time in milliseconds, how long to sleep

Definition at line 27 of file StdHelpers.cpp.

std::string nrEngine::trim ( const std::string &  str  ) 

Delete spaces in the given string.

Parameters:
str String to trim

Definition at line 85 of file StdHelpers.cpp.


Generated on Wed Sep 12 23:19:43 2007 for nrEngine by  doxygen 1.5.1