Program Listing for File Change.hpp

↰ Return to documentation for file (/tmp/ws/src/rmf_traffic/rmf_traffic/include/rmf_traffic/schedule/Change.hpp)

/*
 * Copyright (C) 2020 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_TRAFFIC__SCHEDULE__CHANGE_HPP
#define RMF_TRAFFIC__SCHEDULE__CHANGE_HPP

#include <rmf_traffic/schedule/Itinerary.hpp>
#include <rmf_traffic/schedule/Participant.hpp>
#include <rmf_traffic/schedule/Version.hpp>

#include <rmf_utils/macros.hpp>

namespace rmf_traffic {
namespace schedule {

using StorageId = uint64_t;

//==============================================================================
class Change
{
public:

  //============================================================================
  class Add
  {
  public:

    struct Item
    {
      RouteId route_id;

      StorageId storage_id;

      ConstRoutePtr route;
    };

    Add(PlanId plan, std::vector<Item> additions);

    const std::vector<Item>& items() const;

    PlanId plan_id() const;

    class Implementation;
  private:
    rmf_utils::impl_ptr<Implementation> _pimpl;
  };

  //============================================================================
  class Delay
  {
  public:

    Delay(Duration duration);

    Duration duration() const;

    class Implementation;
  private:
    rmf_utils::impl_ptr<Implementation> _pimpl;
  };

  //============================================================================
  class Erase
  {
  public:

    Erase(std::vector<StorageId> ids);

    const std::vector<StorageId>& ids() const;

    class Implementation;
  private:
    rmf_utils::impl_ptr<Implementation> _pimpl;
  };

  //============================================================================
  class Progress
  {
  public:

    Progress(
      ProgressVersion version,
      std::vector<CheckpointId> checkpoints);

    ProgressVersion version() const;

    const std::vector<CheckpointId>& checkpoints() const;

    class Implementation;
  private:
    rmf_utils::impl_ptr<Implementation> _pimpl;
  };

  //============================================================================
  class RegisterParticipant
  {
  public:

    RegisterParticipant(
      ParticipantId id,
      ParticipantDescription description);

    ParticipantId id() const;

    const ParticipantDescription& description() const;

    class Implementation;
  private:
    rmf_utils::impl_ptr<Implementation> _pimpl;
  };

  //============================================================================
  class UnregisterParticipant
  {
  public:

    UnregisterParticipant(ParticipantId id);

    ParticipantId id() const;

    class Implementation;
  private:
    rmf_utils::impl_ptr<Implementation> _pimpl;
  };

  //============================================================================
  class UpdateParticipantInfo
  {
  public:
    UpdateParticipantInfo(ParticipantId id, ParticipantDescription desc);

    ParticipantId id() const;

    ParticipantDescription description() const;

    class Implementation;
  private:
    rmf_utils::impl_ptr<Implementation> _pimpl;
  };

  //============================================================================
  class Cull
  {
  public:

    Cull(Time time);

    Time time() const;

    class Implementation;
  private:
    rmf_utils::impl_ptr<Implementation> _pimpl;
  };
};

} // namespace schedule
} // namespace rmf_traffic

#endif // RMF_TRAFFIC__SCHEDULE__CHANGE_HPP