Diagnostics.hh

Go to the documentation of this file.

/*
 * Copyright 2012 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
/* Desc: A diagnostic class
 * Author: Nate Koenig
 * Date: 2 Feb 2011
 */

#ifndef _DIAGNOSTICMANAGER_HH_
#define _DIAGNOSTICMANAGER_HH_

#include <map>
#include <string>

#include "common/SingletonT.hh"
#include "common/Timer.hh"

namespace gazebo
{
  namespace common
  {

    #define DIAG_TIMER(name) DiagnosticManager::Instance()->CreateTimer(name);

    class DiagnosticTimer;
    typedef boost::shared_ptr< DiagnosticTimer > DiagnosticTimerPtr;

    class DiagnosticManager : public SingletonT<DiagnosticManager>
    {
      private: DiagnosticManager();

      private: virtual ~DiagnosticManager();

      public: DiagnosticTimerPtr CreateTimer(const std::string &_name);

      public: void TimerStart(DiagnosticTimer *_timer);

      public: void TimerStop(DiagnosticTimer *_timer);

      public: int GetTimerCount() const;

      public: Time GetTime(int _index) const;

      public: Time GetTime(const std::string &_label) const;

      public: std::string GetLabel(int _index) const;

      public: void SetEnabled(bool _e) {this->enabled = _e;}

      public: inline bool GetEnabled() const {return this->enabled;}

      private: bool enabled;

      private: std::map<std::string, Time> timers;

      // Singleton implementation
      private: friend class SingletonT<DiagnosticManager>;
    };

    class DiagnosticTimer : public Timer
    {
      public: DiagnosticTimer(const std::string &_name) : Timer()
              {
                this->Start();
                this->name = _name;
                this->diagManager->TimerStart(this);
              }

      public: virtual ~DiagnosticTimer()
              {
                this->diagManager->TimerStop(this);
              }

      public: inline const std::string GetName() const
              { return this->name; }

      private: std::string name;

      private: static DiagnosticManager *diagManager;
    };
  }
}
#endif