CCopasiTimer.h

Go to the documentation of this file.

/* Begin CVS Header
   $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/report/CCopasiTimer.h,v $
   $Revision: 1.9 $
   $Name:  $
   $Author: shoops $
   $Date: 2012/04/04 19:17:43 $
   End CVS Header */

// Copyright (C) 2012 - 2011 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc., University of Heidelberg, and The University
// of Manchester.
// All rights reserved.

// Copyright (C) 2001 - 2007 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc. and EML Research, gGmbH.
// All rights reserved.

#ifndef COPASI_CCopasiTimer
#define COPASI_CCopasiTimer

#include "report/CCopasiObject.h"
#include "utilities/CopasiTime.h"

class CCopasiTimer: public CCopasiObject
{
public:
  /**
   * Enumeration of timer types
   */
  enum Type
  {
    WALL = 0,
    PROCESS,
    THREAD
  };

  // Operations
  /**
   * Default constructor
   * @param const Type & type (default: WALL)
   * @param const CCopasiContainer * pParent (default: NULL)
   */
  CCopasiTimer(const Type & type = WALL,
               const CCopasiContainer * pParent = NULL);

  /**
   * Copy constructor
   * @param const CCopasiTimer & src
   * @param const CCopasiContainer * pParent (default: NULL)
   */
  CCopasiTimer(const CCopasiTimer & src,
               const CCopasiContainer * pParent = NULL);

  /**
   *  Destructor.
   */
  ~CCopasiTimer();

  /**
   * Start or restart the timer.
   * @return bool success
   */
  bool start();

  /**
   * Actualizes the timer.
   */
  void refresh();

  /**
   * Retrieve the elapsed time.
   * @return const CCopasiTimeVariable & elapsedTime
   */
  const CCopasiTimeVariable & getElapsedTime() const;

  /**
   * Retrieve the elapsed time in seconds.
   * @return const C_FLOAT64 & elapsedTimeSeconds
   */
  const C_FLOAT64 & getElapsedTimeSeconds() const;

  /**
   * This is the output method for any object. The default implementation
   * provided with CCopasiObject uses the ostream operator<< of the object
  * to print the object. To override this default behavior one needs to
   * reimplement the virtual print function.
   * @param std::ostream * ostream
   */
  virtual void print(std::ostream * ostream) const;

  virtual void * getValuePointer() const;

private:
  // Attributes
  /**
   * The timer type
   */
  Type mType;

  /**
   * The start time of the timer.
   */
  CCopasiTimeVariable mStartTime;

  /**
   * The elapsed time of the timer.
   */
  CCopasiTimeVariable mElapsedTime;

  /**
   * The elapsed time as a double used for reporting.
   */
  C_FLOAT64 mElapsedTimeSeconds;
};

#endif // COPASI_CCopasiTimer