---

Base

The Base Library. More...

Compounds
class	Base
	Acts as the base class for all OSCAR classes. More...
class	OSCARError
	Defines an error object that contains an integer value and an error description. More...
class	Timer
	Measures code execution time. More...
Functions
void	DisplayError (const String &eString)
void	DisplayDebug (const String &debugString)
void	DisplayTrace (const String &traceString)
void	DisplayError (const OSCARError &err)
void	Display (const String &dispString)
template<class T> void	Input (T &t)
template<class T> String	ToString (const T &t)
Variables
const OSCARError	noError
const OSCARError	notSupported
const OSCARError	notInitialized

---

Detailed Description

This library contains low-level functionality for error-handling, string manipulation, timing, etc...

---

Function Documentation

void Display (  const String &    dispString )

Output a String to the console. This method is used to output an String to the console. Parameters: dispString  The String to be displayed. A newline is not added. See also: DisplayError() DisplayError(const String& eString) DisplayDebug() DisplayTrace() ToString()

void DisplayDebug (  const String &    debugString )

Output debug information to the console. This method is used to output debug information to the console. Parameters: debugString  The debug String to be displayed. The words "DEBUG: " will be prefixed to debugString and newline is not added. See also: DisplayError(const String& eString) DisplayError(const OSCARError& err) DisplayTrace() Display() ToString()

void DisplayError (  const OSCARError &    err )

Output error information to the console. This method is used to output error information to the console. Parameters: err  The OSCARError object to be displayed. See also: DisplayError(const String& eString) DisplayTrace() DisplayDebug() Display() ToString()

void DisplayError (  const String &    eString )

Output error information to the console. This method is used to output error information to the console. Parameters: eString  The error String to be displayed. The words "ERROR: " will be prefixed to eString and newline is not added. See also: DisplayError(const OSCARError& err) DisplayDebug() DisplayTrace() Display() ToString()

void DisplayTrace (  const String &    traceString )

Output program trace information to the console. This method is used to output program trace information to the console. Parameters: traceString  The trace String to be displayed. The words "TRACE: " will be prefixed to traceString and newline is not added. See also: DisplayError(const String& eString) DisplayError(const OSCARError& err) DisplayDebug() Display() ToString()

template<class T> void Input (  T &    t )

Read any particular type from the console. This Template function allows the program to read any particular type of data from the console. Parameters: t  On return, this will contain the data read during input.

template<class T> String ToString (  const T &    t )  [inline]

Template function to serialize any type to a String. This template function serialize's any type to a String. This will work only for objects for whom the operator << has been defined. Parameters: t  The object to serialize to String. Returns: A String that contains the serialized object.

---

Variable Documentation

const OSCARError OSCAR::noError

This indicates a "No Error" state. This indicates a "No Error" state.

const OSCARError OSCAR::notInitialized

This indicates that the Initialize() method was not called prior to calling other methods.

const OSCARError OSCAR::notSupported

This indicates that a particular functionality is not supported. This indicates that a particular functionality is not supported.

RRG Homepage

OSCAR Overview

OSCAR Tutorials

Simulations