Checkpoint.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 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 IGNITION_RNDF_CHECKPOINT_HH_
#define IGNITION_RNDF_CHECKPOINT_HH_

#include <memory>

#include "ignition/rndf/Helpers.hh"

namespace ignition
{
  namespace rndf
  {
    // Forward declarations.
    class CheckpointPrivate;

    class IGNITION_RNDF_VISIBLE Checkpoint
    {
      public: Checkpoint();

      public: explicit Checkpoint(const int _checkpointId,
                                  const int _waypointId);

      public: Checkpoint(const Checkpoint &_other);

      public: virtual ~Checkpoint();

      public: int CheckpointId() const;

      public: bool SetCheckpointId(const int _id);

      public: int WaypointId() const;

      public: bool SetWaypointId(const int _id);

      public: bool Valid() const;

      public: bool operator==(const Checkpoint &_other) const;

      public: bool operator!=(const Checkpoint &_other) const;

      public: Checkpoint &operator=(const Checkpoint &_other);

      private: std::unique_ptr<CheckpointPrivate> dataPtr;
    };
  }
}
#endif