Tools/Xabsl2/GT/GTXabsl2Profiler/GTXabsl2Profiler.h

Go to the documentation of this file.

/**
* @file GTXabsl2Profiler.h
* 
* Definition and Implementation of classes GTXabsl2Profiler, GTXabsl2ProfilerNameTable
*
* @author Michael Spranger
*/
#ifndef __GTXabsl2Profiler_h_
#define __GTXabsl2Profiler_h_

#ifdef _WIN32
#pragma warning(disable:4786) 
// the constructor with all it's long parameter type names results in a too
// long debug identifier
#endif

#include <string>
#include <vector>
#include <deque>

#include "Platform/GTAssert.h"

#include "Tools/Streams/OutStreams.h"
#include "Platform/SystemCall.h"


#include "Tools/Xabsl2/Xabsl2Engine/Xabsl2Engine.h"
#include "Tools/Debugging/Debugging.h"

#include "Tools/Streams/InStreams.h"
#include "Tools/Module/SolutionRequest.h"

#include "GTXabsl2ProfilerLog.h"

/* Nr of Logelements written out per call to writeLog */
#define NROFELEMW 2


/**
* @class GTXabsl2Profiler
* Class for profiling and analysis of Xabsl-Activation-Paths
* @author Michael Spranger
*/
class GTXabsl2Profiler
{
private:

  /** Name of the file the Log is written to */
  std::string logFileName;

  /** A reference to a variable containing the current frame number */
  const unsigned long* frameNumber;

public:
  
  /** The log. */
  GTXabsl2Log log;

  /** The Xabsl-Output-Symbols for the Profiler */
  enum { dontCollectProfiles, collectProfiles} profilerCollectMode;
  enum { dontWriteProfiles, writeProfiles, writeCompleteProfiles} profilerWriteMode;
  
  /*
   * Called by Xabls-Engine to make profiler symbols visible to behavior
   */
  void registerSymbols(Xabsl2Engine&);

  GTXabsl2Profiler();
  /** Constructor
  * @param id The id of the observed xabsl engine 
  * @param frameNumber A reference to the frame number
  */ 
  GTXabsl2Profiler(SolutionRequest::xabsl2EngineID id,
      const unsigned long* frameNumber);

  /*
   *  Initialises Engine, creates nametable and writes it to logFileName
   * @param pEnginge Reference to the engine to be profiled
   */
  void init(Xabsl2Engine& pEngine);

  /*
   * Runs through the Engine determine active options, states and their parameters, writes the option-activation-path to log
   * @param pEngine XabslEngine to be profiled
   */
  void recordLog(Xabsl2Engine& pEngine);

  /*
   * Write a certain number (NROFELEMW) of logs to logFileName, erasing them from the log.
   */
  void writeLogEntriesToFileAndRemove(int numberOfLogs = 2);

  /*
   * Writes the complete log to logFileName, erasing all up to now collected logs.
   */
  void writeCompleteLogToFileAndClear();
 
};

#endif// __GTXabsl2Profiler_h_

---