WorldStats.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 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.
 *
*/

#ifndef IGNITION_GUI_PLUGINS_WORLDSTATS_HH_
#define IGNITION_GUI_PLUGINS_WORLDSTATS_HH_

#include <memory>

#include <ignition/msgs.hh>
#include <ignition/transport.hh>

#include "ignition/gui/Export.hh"
#include "ignition/gui/Plugin.hh"

#ifndef _WIN32
#  define WorldStats_EXPORTS_API
#else
#  if (defined(WorldStats_EXPORTS))
#    define WorldStats_EXPORTS_API __declspec(dllexport)
#  else
#    define WorldStats_EXPORTS_API __declspec(dllimport)
#  endif
#endif

namespace ignition
{
namespace gui
{
namespace plugins
{
  class WorldStatsPrivate;

  class WorldStats_EXPORTS_API WorldStats: public ignition::gui::Plugin
  {
    Q_OBJECT

    Q_PROPERTY(
      QString realTimeFactor
      READ RealTimeFactor
      WRITE SetRealTimeFactor
      NOTIFY RealTimeFactorChanged
    )

    
    Q_PROPERTY(
      QString simTime
      READ SimTime
      WRITE SetSimTime
      NOTIFY SimTimeChanged
    )

    Q_PROPERTY(
      QString realTime
      READ RealTime
      WRITE SetRealTime
      NOTIFY RealTimeChanged
    )

    Q_PROPERTY(
      QString iterations
      READ Iterations
      WRITE SetIterations
      NOTIFY IterationsChanged
    )

    public: WorldStats();

    public: virtual ~WorldStats();

    // Documentation inherited
    public: void LoadConfig(const tinyxml2::XMLElement *_pluginElem);

    public slots: void ProcessMsg();

    public: Q_INVOKABLE QString RealTimeFactor() const;

    public: Q_INVOKABLE void SetRealTimeFactor(const QString &_realTimeFactor);

    signals: void RealTimeFactorChanged();

    public: Q_INVOKABLE QString SimTime() const;

    public: Q_INVOKABLE void SetSimTime(const QString &_simTime);

    signals: void SimTimeChanged();

    public: Q_INVOKABLE QString RealTime() const;

    public: Q_INVOKABLE void SetRealTime(const QString &_realTime);

    signals: void RealTimeChanged();

    public: Q_INVOKABLE QString Iterations() const;

    public: Q_INVOKABLE void SetIterations(const QString &_iterations);

    signals: void IterationsChanged();

    private: void OnWorldStatsMsg(const ignition::msgs::WorldStatistics &_msg);

    // Private data
    private: std::unique_ptr<WorldStatsPrivate> dataPtr;
  };
}
}
}

#endif