WorldState.hh

Go to the documentation of this file.

/*
 * Copyright (C) 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 world state
 * Author: Nate Koenig
 */

#ifndef GAZEBO_PHYSICS_WORLDSTATE_HH_
#define GAZEBO_PHYSICS_WORLDSTATE_HH_

#include <string>
#include <vector>

#include <sdf/sdf.hh>

#include "gazebo/physics/State.hh"
#include "gazebo/physics/ModelState.hh"
#include "gazebo/physics/LightState.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace physics
  {

    class GZ_PHYSICS_VISIBLE WorldState : public State
    {
      public: WorldState();

      public: explicit WorldState(const WorldPtr _world);

      public: explicit WorldState(const sdf::ElementPtr _sdf);

      public: virtual ~WorldState();

      public: void Load(const WorldPtr _world);

      public: void LoadWithFilter(const WorldPtr _world,
          const std::string &_filter);

      public: virtual void Load(const sdf::ElementPtr _elem);

      public: void SetWorld(const WorldPtr _world);

      public: ModelState_M GetModelStates(const boost::regex &_regex) const;

      public: const ModelState_M &GetModelStates() const;

      public: const LightState_M &LightStates() const;

      public: unsigned int GetModelStateCount() const;

      public: unsigned int LightStateCount() const;

      public: ModelState GetModelState(const std::string &_modelName) const;

      public: LightState GetLightState(const std::string &_lightName) const;

      public: bool HasModelState(const std::string &_modelName) const;

      public: bool HasLightState(const std::string &_lightName) const;

      public: const std::vector<std::string> &Insertions() const;

      public: void SetInsertions(const std::vector<std::string> &_insertions);

      public: const std::vector<std::string> &Deletions() const;

      public: void SetDeletions(const std::vector<std::string> &_deletions);

      public: bool IsZero() const;

      public: void FillSDF(sdf::ElementPtr _sdf);

      public: virtual void SetWallTime(const common::Time &_time);

      public: virtual void SetRealTime(const common::Time &_time);

      public: virtual void SetSimTime(const common::Time &_time);

      public: virtual void SetIterations(const uint64_t _iterations);

      public: WorldState &operator=(const WorldState &_state);

      public: WorldState operator-(const WorldState &_state) const;

      public: WorldState operator+(const WorldState &_state) const;

      public: inline friend std::ostream &operator<<(std::ostream &_out,
                  const gazebo::physics::WorldState &_state)
      {
        _out << "<state world_name='" << _state.name << "'>"
          << "<sim_time>" << _state.simTime << "</sim_time>"
          << "<wall_time>" << _state.wallTime << "</wall_time>"
          << "<real_time>" << _state.realTime << "</real_time>"
          << "<iterations>" << _state.iterations << "</iterations>";

        // List all of the inserted models
        if (_state.insertions.size() > 0)
        {
          _out << "<insertions>";
          for (std::vector<std::string>::const_iterator iter =
               _state.insertions.begin();
               iter != _state.insertions.end(); ++iter)
          {
            _out << *iter;
          }
          _out << "</insertions>";
        }

        // List all of the deleted models
        if (_state.deletions.size() > 0)
        {
          _out << "<deletions>";
          for (std::vector<std::string>::const_iterator iter =
               _state.deletions.begin();
               iter != _state.deletions.end(); ++iter)
          {
            _out << "<name>" << (*iter) << "</name>";
          }
          _out << "</deletions>";
        }

        // List the model states
        for (const auto &model : _state.modelStates)
        {
          _out << model.second;
        }

        // List the light states
        for (const auto &light : _state.lightStates)
        {
          _out << light.second;
        }

        _out << "</state>";

        return _out;
      }

      private: ModelState_M modelStates;

      private: LightState_M lightStates;

      private: std::vector<std::string> insertions;

      private: std::vector<std::string> deletions;

      private: WorldPtr world;
    };
  }
}
#endif