Program Listing for File SimpleEventState.hpp

↰ Return to documentation for file (include/rmf_task/events/SimpleEventState.hpp)

/*
 * 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.
 *
*/

#ifndef RMF_TASK__EVENTS__SIMPLEEVENTSTATE_HPP
#define RMF_TASK__EVENTS__SIMPLEEVENTSTATE_HPP

#include <rmf_task/Event.hpp>

namespace rmf_task {
namespace events {

//==============================================================================
class SimpleEventState : public Event::State
{
public:

  static std::shared_ptr<SimpleEventState> make(
    uint64_t id,
    std::string name,
    std::string detail,
    Status initial_status,
    std::vector<ConstStatePtr> dependencies = {},
    std::function<rmf_traffic::Time()> clock = nullptr);

  // Documentation inherited
  uint64_t id() const final;

  SimpleEventState& modify_id(uint64_t new_id);

  // Documentation inherited
  Status status() const final;

  SimpleEventState& update_status(Status new_status);

  // Documentation inherited
  VersionedString::View name() const final;

  SimpleEventState& update_name(std::string new_name);

  // Documentation inherited
  VersionedString::View detail() const final;

  SimpleEventState& update_detail(std::string new_detail);

  // Documentation inherited
  Log::View log() const final;

  Log& update_log();

  // Documentation inherited
  std::vector<ConstStatePtr> dependencies() const final;

  SimpleEventState& update_dependencies(
    std::vector<ConstStatePtr> new_dependencies);

  SimpleEventState& add_dependency(ConstStatePtr new_dependency);

  class Implementation;
private:
  SimpleEventState();
  rmf_utils::unique_impl_ptr<Implementation> _pimpl;
};

using SimpleEventStatePtr = std::shared_ptr<SimpleEventState>;

} // namespace events
} // namespace rmf_task

#endif // RMF_TASK__EVENTS__SIMPLEEVENTSTATE_HPP