UniqueId.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_UNIQUEID_HH_
#define IGNITION_RNDF_UNIQUEID_HH_

#include <iostream>
#include <string>
#include "ignition/rndf/Helpers.hh"

namespace ignition
{
  namespace rndf
  {
    class IGNITION_RNDF_VISIBLE UniqueId
    {
      public: UniqueId();

      public: explicit UniqueId(const int _x,
                                const int _y,
                                const int _z);

      public: explicit UniqueId(const std::string &_id);

      public: UniqueId(const UniqueId &_other);

      public: virtual ~UniqueId();

      public: int X() const;

      public: bool SetX(const int _x);

      public: int Y() const;

      public: bool SetY(const int _y);

      public: int Z() const;

      public: bool SetZ(const int _z);

      public: bool Valid() const;

      public: std::string String() const;

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

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

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

      public: friend std::ostream &operator<<(std::ostream &_out,
                                              const UniqueId &_id)
      {
        _out << _id.X() << "." << _id.Y() << "." << _id.Z();
        return _out;
      }

      private: int x;

      private: int y;

      private: int z;
    };
  }
}
#endif