RNDF.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_RNDF_HH_
#define IGNITION_RNDF_RNDF_HH_

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

#include "ignition/rndf/Helpers.hh"

namespace ignition
{
  namespace rndf
  {
    // Forward declarations.
    class RNDFHeaderPrivate;
    class RNDFNode;
    class RNDFPrivate;
    class Segment;
    class UniqueId;
    class Zone;

    // \internal
    class RNDFHeader
    {
      public: RNDFHeader();

      public: ~RNDFHeader() = default;


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


      public: std::string Version() const;

      public: void SetVersion(const std::string &_version) const;


      public: std::string Date() const;

      public: void SetDate(const std::string &_newDate) const;

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

    class IGNITION_RNDF_VISIBLE RNDF
    {
      public: RNDF();

      public: explicit RNDF(const std::string &_filepath);

      public: virtual ~RNDF();


      public: bool Load(const std::string &_filePath);


      public: std::string Name() const;

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


      public: unsigned int NumSegments() const;

      public: std::vector<rndf::Segment> &Segments();

      public: const std::vector<rndf::Segment> &Segments() const;

      public: bool Segment(const int _segmentId,
                           rndf::Segment &_segment) const;

      public: bool UpdateSegment(const rndf::Segment &_segment);

      public: bool AddSegment(const rndf::Segment &_newSegment);

      public: bool RemoveSegment(const int _segmentId);


      public: unsigned int NumZones() const;

      public: std::vector<rndf::Zone> &Zones();

      public: const std::vector<rndf::Zone> &Zones() const;

      public: bool Zone(const int _zoneId,
                        rndf::Zone &_zone) const;

      public: bool UpdateZone(const rndf::Zone &_zone);

      public: bool AddZone(const rndf::Zone &_newZone);

      public: bool RemoveZone(const int _zoneId);


      public: std::string Version() const;

      public: void SetVersion(const std::string &_version) const;


      public: std::string Date() const;

      public: void SetDate(const std::string &_newDate) const;


      public: bool Valid() const;


      public: RNDFNode *Info(const rndf::UniqueId &_id) const;

      private: void UpdateCache();

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