DoorTimer.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2021 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.
 *
 */
 
/*
 * \author Nick Lamprianidis <nlamprian@gmail.com>
 * \date January 2021
 */
 
#ifndef GZ_SIM_SYSTEMS_DOOR_TIMER_HH_
#define GZ_SIM_SYSTEMS_DOOR_TIMER_HH_
 
#include <chrono>
#include <functional>
#include <memory>
 
#include <gz/sim/System.hh>
 
namespace gz
{
namespace sim
{
// Inline bracket to help doxygen filtering
inline namespace GZ_SIM_VERSION_NAMESPACE {
namespace systems
{
// Data forward declaration
class DoorTimerPrivate;
 
class DoorTimer
{
  public: DoorTimer(const std::chrono::steady_clock::duration &_waitDuration);
 
  public: ~DoorTimer();
 
  public: void Configure(const std::chrono::steady_clock::duration &_startTime,
                         const std::function<void()> &_timeoutCallback);
 
  public: void Update(const UpdateInfo &_info, bool _isDoorwayBlocked);
 
  private: std::unique_ptr<DoorTimerPrivate> dataPtr;
};
 
}  // namespace systems
}  // namespace GZ_SIM_VERSION_NAMESPACE
}  // namespace sim
}  // namespace gz
 
#endif  // GZ_SIM_SYSTEMS_DOOR_TIMER_HH_