Zone.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_ZONE_HH_
#define IGNITION_RNDF_ZONE_HH_

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

#include "ignition/rndf/Helpers.hh"

namespace ignition
{
  namespace rndf
  {
    // Forward declarations.
    class ParkingSpot;
    class Perimeter;
    class ZoneHeaderPrivate;
    class ZonePrivate;

    class ZoneHeader
    {
      public: ZoneHeader();

      public: ~ZoneHeader() = default;


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


      public: std::string Name() const;

      public: void SetName(const std::string &_name) const;

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

    class IGNITION_RNDF_VISIBLE Zone
    {
      public: explicit Zone();

      public: explicit Zone(const int _id);

      public: Zone(const Zone &_other);

      public: virtual ~Zone();


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


      public: int Id() const;

      public: bool SetId(const int _id);


      public: unsigned int NumSpots() const;

      public: std::vector<ParkingSpot> &Spots();

      public: const std::vector<ParkingSpot> &Spots() const;

      public: bool Spot(const int _psId,
                        ParkingSpot &_ps) const;

      public: bool UpdateSpot(const ParkingSpot &_ps);

      public: bool AddSpot(const ParkingSpot &_newSpot);

      public: bool RemoveSpot(const int _psId);


      public: rndf::Perimeter &Perimeter();

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


      public: std::string Name() const;

      public: void SetName(const std::string &_name) const;


      public: bool Valid() const;


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

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

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

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