Murl::System Functions

Basic system functions. More...

Collaboration diagram for Murl::System Functions:

Modules

 Murl::System::CLib Functions
 Forward to C-runtime library functions.
 

Functions

Bool Murl::System::Init ()
 Initialize the System module. More...
 
Bool Murl::System::DeInit ()
 Deinitialize the System module. More...
 
void Murl::System::Sleep (const Time &sleepTime)
 Sleep for a specified time. More...
 
UInt16 Murl::System::BigEndianToHost (UInt16 value)
 Convert a big endian ordered 16 bit integer to host byte ordering. More...
 
UInt16 Murl::System::LittleEndianToHost (UInt16 value)
 Convert a little endian ordered 16 bit integer to host byte ordering. More...
 
UInt16 Murl::System::HostToBigEndian (UInt16 value)
 Convert a host ordered 16 bit integer to big endian byte ordering. More...
 
UInt16 Murl::System::HostToLittleEndian (UInt16 value)
 Convert a host ordered 16 bit integer to little endian byte ordering. More...
 
UInt32 Murl::System::BigEndianToHost (UInt32 value)
 Convert a big endian ordered 32 bit integer to host byte ordering. More...
 
UInt32 Murl::System::LittleEndianToHost (UInt32 value)
 Convert a little endian ordered 32 bit integer to host byte ordering. More...
 
UInt32 Murl::System::HostToBigEndian (UInt32 value)
 Convert a host ordered 32 bit integer to big endian byte ordering. More...
 
UInt32 Murl::System::HostToLittleEndian (UInt32 value)
 Convert a host ordered 32 bit integer to little endian byte ordering. More...
 
UInt64 Murl::System::BigEndianToHost (UInt64 value)
 Convert a big endian ordered 64 bit integer to host byte ordering. More...
 
UInt64 Murl::System::LittleEndianToHost (UInt64 value)
 Convert a little endian ordered 64 bit integer to host byte ordering. More...
 
UInt64 Murl::System::HostToBigEndian (UInt64 value)
 Convert a host ordered 64 bit integer to big endian byte ordering. More...
 
UInt64 Murl::System::HostToLittleEndian (UInt64 value)
 Convert a host ordered 64 bit integer to little endian byte ordering. More...
 
String Murl::System::GetAbsolutePathOfCurrentExecutable ()
 Get the absolute path of the currently running executable. More...
 
String Murl::System::GetNameOfShellExecutable (const String &path, const String &name)
 Get the fully qualified name of a command line executable. More...
 
String Murl::System::GetNameOfGuiExecutable (const String &path, const String &name)
 Get the fully qualified name of a GUI executable. More...
 
String Murl::System::DemangleTypeName (const Char *name)
 Demangle a RTTI name. More...
 

Detailed Description

Basic system functions.

Function Documentation

◆ Init()

Bool Murl::System::Init ( )

Initialize the System module.

This method is called by the engine's Murl::Engine::Init() method.

Returns
true if successful.

◆ DeInit()

Bool Murl::System::DeInit ( )

Deinitialize the System module.

This method is called by the engine's Murl::Engine::DeInit() method.

Returns
true if successful.

◆ Sleep()

void Murl::System::Sleep ( const Time sleepTime)

Sleep for a specified time.

Parameters
sleepTimeThe time to sleep.

◆ BigEndianToHost() [1/3]

UInt16 Murl::System::BigEndianToHost ( UInt16  value)

Convert a big endian ordered 16 bit integer to host byte ordering.

Parameters
valueThe big endian integer to convert.
Returns
The integer in host byte ordering.

◆ LittleEndianToHost() [1/3]

UInt16 Murl::System::LittleEndianToHost ( UInt16  value)

Convert a little endian ordered 16 bit integer to host byte ordering.

Parameters
valueThe little endian integer to convert.
Returns
The integer in host byte ordering.

◆ HostToBigEndian() [1/3]

UInt16 Murl::System::HostToBigEndian ( UInt16  value)

Convert a host ordered 16 bit integer to big endian byte ordering.

Parameters
valueThe host integer to convert.
Returns
The integer in big endian byte ordering.

◆ HostToLittleEndian() [1/3]

UInt16 Murl::System::HostToLittleEndian ( UInt16  value)

Convert a host ordered 16 bit integer to little endian byte ordering.

Parameters
valueThe host integer to convert.
Returns
The integer in little endian byte ordering.

◆ BigEndianToHost() [2/3]

UInt32 Murl::System::BigEndianToHost ( UInt32  value)

Convert a big endian ordered 32 bit integer to host byte ordering.

Parameters
valueThe big endian integer to convert.
Returns
The integer in host byte ordering.

◆ LittleEndianToHost() [2/3]

UInt32 Murl::System::LittleEndianToHost ( UInt32  value)

Convert a little endian ordered 32 bit integer to host byte ordering.

Parameters
valueThe little endian integer to convert.
Returns
The integer in host byte ordering.

◆ HostToBigEndian() [2/3]

UInt32 Murl::System::HostToBigEndian ( UInt32  value)

Convert a host ordered 32 bit integer to big endian byte ordering.

Parameters
valueThe host integer to convert.
Returns
The integer in big endian byte ordering.

◆ HostToLittleEndian() [2/3]

UInt32 Murl::System::HostToLittleEndian ( UInt32  value)

Convert a host ordered 32 bit integer to little endian byte ordering.

Parameters
valueThe host integer to convert.
Returns
The integer in little endian byte ordering.

◆ BigEndianToHost() [3/3]

UInt64 Murl::System::BigEndianToHost ( UInt64  value)

Convert a big endian ordered 64 bit integer to host byte ordering.

Parameters
valueThe big endian integer to convert.
Returns
The integer in host byte ordering.

◆ LittleEndianToHost() [3/3]

UInt64 Murl::System::LittleEndianToHost ( UInt64  value)

Convert a little endian ordered 64 bit integer to host byte ordering.

Parameters
valueThe little endian integer to convert.
Returns
The integer in host byte ordering.

◆ HostToBigEndian() [3/3]

UInt64 Murl::System::HostToBigEndian ( UInt64  value)

Convert a host ordered 64 bit integer to big endian byte ordering.

Parameters
valueThe host integer to convert.
Returns
The integer in big endian byte ordering.

◆ HostToLittleEndian() [3/3]

UInt64 Murl::System::HostToLittleEndian ( UInt64  value)

Convert a host ordered 64 bit integer to little endian byte ordering.

Parameters
valueThe host integer to convert.
Returns
The integer in little endian byte ordering.

◆ GetAbsolutePathOfCurrentExecutable()

String Murl::System::GetAbsolutePathOfCurrentExecutable ( )

Get the absolute path of the currently running executable.

Platforms not supporting this will return an empty string.

Returns
The absolute path to the currently running executable.

◆ GetNameOfShellExecutable()

String Murl::System::GetNameOfShellExecutable ( const String path,
const String name 
)

Get the fully qualified name of a command line executable.

Parameters
pathThe path to the executable
nameThe name of the executable
Returns
The full path.

◆ GetNameOfGuiExecutable()

String Murl::System::GetNameOfGuiExecutable ( const String path,
const String name 
)

Get the fully qualified name of a GUI executable.

Parameters
pathThe path to the executable
nameThe name of the executable
Returns
The full path.

◆ DemangleTypeName()

String Murl::System::DemangleTypeName ( const Char name)

Demangle a RTTI name.

Convert a RTTI name to a human readable string.

#include <typeinfo>
String className = System::DemangleTypeName(typeid(MyClass).name());
Parameters
nameThe RTTI name to demangle.
Returns
The demangled name.

Referenced by Murl::Util::MessageMethod< MessageClass, ObjectClass >::Execute().


Copyright © 2011-2018 Spraylight GmbH.