ParkingSpot.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_PARKINGSPOT_HH_
#define IGNITION_RNDF_PARKINGSPOT_HH_

#include <iosfwd>
#include <memory>
#include <vector>

#include "ignition/rndf/Helpers.hh"

namespace ignition
{
  namespace rndf
  {
    // Forward declarations.
    class Checkpoint;
    class ParkingSpotPrivate;
    class ParkingSpotHeaderPrivate;
    class Waypoint;

    class ParkingSpotHeader
    {
      public: ParkingSpotHeader();

      public: ~ParkingSpotHeader() = default;


      public: bool Load(std::ifstream &_rndfFile,
                        const int _zoneId,
                        const int _spotId,
                        int &_lineNumber);


      public: double Width() const;

      public: bool SetWidth(const double _newWidth);


      public: rndf::Checkpoint &Checkpoint();

      public: const rndf::Checkpoint &Checkpoint() const;

      private: std::unique_ptr<ParkingSpotHeaderPrivate> dataPtr;
    };

    class IGNITION_RNDF_VISIBLE ParkingSpot
    {
      public: ParkingSpot();

      public: explicit ParkingSpot(const int _spotId);

      public: ParkingSpot(const ParkingSpot &_other);

      public: virtual ~ParkingSpot();


      public: bool Load(std::ifstream &_rndfFile,
                        const int _zoneId,
                        int &_lineNumber);


      public: int Id() const;

      public: bool SetId(const int _id);


      public: unsigned int NumWaypoints() const;

      public: std::vector<rndf::Waypoint> &Waypoints();

      public: const std::vector<rndf::Waypoint> &Waypoints() const;

      public: bool Waypoint(const int _wpId,
                            rndf::Waypoint &_wp) const;

      public: bool UpdateWaypoint(const rndf::Waypoint &_wp);

      public: bool AddWaypoint(const rndf::Waypoint &_newWaypoint);

      public: bool RemoveWaypoint(const int _wpId);


      public: double Width() const;

      public: bool SetWidth(const double _newWidth);


      public: rndf::Checkpoint &Checkpoint();

      public: const rndf::Checkpoint &Checkpoint() const;


      public: bool Valid() const;


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

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

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

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