Version 1.2 (June 2013)
 All Classes Namespaces Files Functions Variables Pages
Static Public Member Functions | Static Public Attributes | List of all members
utils.InitialisationErrorLog Class Reference

Creates and updates a simulation initialisation error log file for the initialising simulation. More...

Static Public Member Functions

static void openInitialisationErrorFile (String dirName)
 Open a logFile at a specified directory, and initialises the time recorder. More...
 
static void writeLog (String message)
 Static method to add message to the log file, even when quiet mode is enabled. More...
 
static void writeError (String message, String origin)
 Static method to add message to the log file, so long as Idynomics.quietMode is false (default) More...
 
static void closeFile ()
 Closes the log file. More...
 
static void deleteFile ()
 Deletes the log file if no errors have been logged. More...
 

Static Public Attributes

static FileOutputStream log
 
static long anInstant
 

Detailed Description

Creates and updates a simulation initialisation error log file for the initialising simulation.

Creates and updates a simulation initialisation error log file for the initialising simulation

Member Function Documentation

static void utils.InitialisationErrorLog.closeFile ( )
static

Closes the log file.

Closes the log file

static void utils.InitialisationErrorLog.deleteFile ( )
static

Deletes the log file if no errors have been logged.

Deletes the log file if no errors have been logged

static void utils.InitialisationErrorLog.openInitialisationErrorFile ( String  dirName)
static

Open a logFile at a specified directory, and initialises the time recorder.

Open a logFile at a specified directory, and initialises the time recorder

Parameters
dirNameDirectory where the log file should be stored
static void utils.InitialisationErrorLog.writeError ( String  message,
String  origin 
)
static

Static method to add message to the log file, so long as Idynomics.quietMode is false (default)

Static method to add message to the log file, so long as Idynomics.quietMode is false (default)

Parameters
messageThe message that should be appended to the log file
originOrigin of where this message came from
static void utils.InitialisationErrorLog.writeLog ( String  message)
static

Static method to add message to the log file, even when quiet mode is enabled.

Static method to add message to the log file, even when quiet mode is enabled

Parameters
messageThe message that should be appended to the log file

Member Data Documentation

long utils.InitialisationErrorLog.anInstant
static

Used to hold simulation time at the time of logging

FileOutputStream utils.InitialisationErrorLog.log
static

Output stream which log messages are written to


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