include/gz/sim/Types.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 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 GZ_SIM_TYPES_HH_
#define GZ_SIM_TYPES_HH_
 
#include <chrono>
#include <cstdint>
#include <functional>
#include <utility>
 
#include "gz/sim/Entity.hh"
 
namespace gz
{
  namespace sim
  {
    // Inline bracket to help doxygen filtering.
    inline namespace GZ_SIM_VERSION_NAMESPACE {
    // Forward declarations.
    class EntityComponentManager;
 
    struct UpdateInfo
    {
      std::chrono::steady_clock::duration simTime{0};
 
      std::chrono::steady_clock::duration realTime{0};
 
      std::chrono::steady_clock::duration dt{0};
 
      // cppcheck-suppress unusedStructMember
      uint64_t iterations{0};
 
      // cppcheck-suppress unusedStructMember
      bool paused{true};
    };
 
    enum class ComponentState
    {
      NoChange = 0,
 
      PeriodicChange = 1,
 
      OneTimeChange = 2
    };
 
    using ComponentTypeId = uint64_t;
 
    using EntityQueryCallback = std::function<void (const UpdateInfo,
        EntityComponentManager &)>;
 
    static const ComponentTypeId kComponentTypeIdInvalid = UINT64_MAX;
    }
  }
}
#endif