gz/physics/FrameID.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 GZ_PHYSICS_FRAMEID_HH_
#define GZ_PHYSICS_FRAMEID_HH_
 
#include <memory>
 
#include <gz/physics/Export.hh>
#include <gz/physics/detail/Identity.hh>
#include <gz/utilities/SuppressWarning.hh>
 
namespace ignition
{
  namespace physics
  {
    // Forward declaration
    class FrameSemantics;
 
    class IGNITION_PHYSICS_VISIBLE FrameID final
    {
      // Comparison operators
      public: bool operator ==(const FrameID &_other) const;
      public: bool operator <(const FrameID &_other) const;
      public: bool operator >(const FrameID &_other) const;
      public: bool operator <=(const FrameID &_other) const;
      public: bool operator >=(const FrameID &_other) const;
      public: bool operator !=(const FrameID &_other) const;
 
      // Explicitly allow default copy constructors and assignment operators
      public: FrameID(const FrameID&) = default;
      public: FrameID(FrameID&&) = default;
      public: FrameID &operator =(const FrameID&) = default;
      public: FrameID &operator =(FrameID&&) = default;
 
      public: static const FrameID &World();
 
      public: std::size_t ID() const;
 
      public: bool IsWorld() const;
 
      public: bool IsReferenceCounted() const;
 
      private: explicit FrameID(const Identity &_identity);
 
      private: enum WorldConstructorArg { ConstructWorld };
 
      private: explicit FrameID(WorldConstructorArg);
 
      // Friendship declaration
      friend class FrameSemantics;
 
      private: std::size_t id;
 
      IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::shared_ptr<const void> ref;
      IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}
 
#endif