ETTreeLog Class Reference

This class along with ETreeLogVisitor form the envisioned ETree viewer. More...

Inherits Simba::DSI::DSILog.

List of all members.

Public Member Functions

virtual void DumpToLog (ETNode *in_root)
 Log the given AE tree.
 ETTreeLog (const simba_wstring &in_filename)
 Constructor.
virtual ~ETTreeLog ()
 Destructor.

Static Public Member Functions

static simba_wstring DumpToString (ETNode *in_root)
 Log the given tree to a string.

Protected Member Functions

virtual void FormatLogLine (LogLevel in_logLevel, const simba_char *const in_namespace, const simba_char *const in_className, const simba_char *const in_functionName, const simba_char *const in_messageFormat, simba_string &out_logLine)
 Formats the log line before it is written.

Detailed Description

This class along with ETreeLogVisitor form the envisioned ETree viewer.


Constructor & Destructor Documentation

ETTreeLog ( const simba_wstring in_filename  )  [explicit]

Constructor.

Parameters:
in_filename Filename of log to open.
virtual ~ETTreeLog (  )  [virtual]

Destructor.


Member Function Documentation

virtual void DumpToLog ( ETNode in_root  )  [virtual]

Log the given AE tree.

Parameters:
in_root The root node of an ET tree. (NOT OWN)
static simba_wstring DumpToString ( ETNode in_root  )  [static]

Log the given tree to a string.

in_root The root node of an ET tree. (NOT OWN)

Returns:
A string containing the log representation of in_root.
virtual void FormatLogLine ( LogLevel  in_logLevel,
const simba_char *const   in_namespace,
const simba_char *const   in_className,
const simba_char *const   in_functionName,
const simba_char *const   in_messageFormat,
simba_string &  out_logLine 
) [protected, virtual]

Formats the log line before it is written.

Parameters:
in_logLevel The log level to include in the log line.
in_namespace The namespace of the function attempting to log. (NOT OWN)
in_className The name of the class to log. (NOT OWN)
in_functionName The name of the function to log. (NOT OWN)
in_messageFormat The format of the message to log. (NOT OWN)
out_logLine Formatted log line.

Reimplemented from DSILog.


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

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