Platform Class Reference

The entry point for all platform specific services. More...

List of all members.

Public Member Functions

simba_wstring GetApplicationName ()
 Returns the executing application name.
simba_wstring GetInitialValue ()
 Returns path to startup information.
const simba_wstringGetLocaleName ()
 Returns the name of the platform's locale.
IODBCStringConverterGetODBCStringConverter ()
 Retrieves an ODBCStringConverter.
IWStreamConverterFactoryGetWStreamConverterFactory ()
 Retrieves a wide string stream converter factory.
IWStringConverterGetWStringConverter ()
 Retrieves a wide string converter.
EncodingType GetWStringEncoding ()
 Returns the native encoding used by simba_wstring.

Static Public Member Functions

static PlatformGetPlatform ()
 Gets the platform singleton. (NOT OWN).
static PlatformInitializePlatform (bool in_traceToStdErr)
 Initializes the platform singleton.
static void LogToStdErr (const std::string &in_message)
 Outputs the given message to stderr stream.
static void SetLogToStdErr (bool in_traceToStdErr)
 Set if logging occers to std::cerr.
static void UninitializePlatform ()
 Uninitializes the platform.

Detailed Description

The entry point for all platform specific services.


Member Function Documentation

simba_wstring GetApplicationName (  ) 

Returns the executing application name.

Returns:
simba_wstring with the application name.
simba_wstring GetInitialValue (  ) 

Returns path to startup information.

Returns:
wstring with local path.
const simba_wstring& GetLocaleName (  ) 

Returns the name of the platform's locale.

Returns:
the name of the platform locale.
IODBCStringConverter* GetODBCStringConverter (  ) 

Retrieves an ODBCStringConverter.

Returns:
an ODBCStringConverter. (NOT OWN).
static Platform* GetPlatform (  )  [inline, static]

Gets the platform singleton. (NOT OWN).

IWStreamConverterFactory* GetWStreamConverterFactory (  )  [inline]

Retrieves a wide string stream converter factory.

Returns:
A wide string stream converter factory object. (NOT OWN)
IWStringConverter* GetWStringConverter (  )  [inline]

Retrieves a wide string converter.

Returns:
A wide string converter. (NOT OWN)
EncodingType GetWStringEncoding (  ) 

Returns the native encoding used by simba_wstring.

Returns:
the native encoding used by simba_wstring on the platform.
static Platform* InitializePlatform ( bool  in_traceToStdErr  )  [static]

Initializes the platform singleton.

Parameters:
in_traceToStdErr Should StdErr tracing be enabled.
Returns:
The initialized platform (NOT OWN)
static void LogToStdErr ( const std::string &  in_message  )  [static]

Outputs the given message to stderr stream.

This is used to log function calls and important information before the Driver is fully initialized. The message will only be output if the traceToStdErr setting is set to true.

Parameters:
in_message Message to be output to stderr stream.
static void SetLogToStdErr ( bool  in_traceToStdErr  )  [static]

Set if logging occers to std::cerr.

Parameters:
in_traceToStdErr True, if the platform is to be constructed/initialized with errors written to std::cerr; False, otherwise.
static void UninitializePlatform (  )  [static]

Uninitializes the platform.


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

Generated on Wed May 17 14:21:19 2017 for SimbaEngine 10.1.3.1011 by simba