.. _program_listing_file__tmp_ws_src_rmf_traffic_rmf_traffic_include_rmf_traffic_detail_bidirectional_iterator.hpp:

Program Listing for File bidirectional_iterator.hpp
===================================================

|exhale_lsh| :ref:`Return to documentation for file <file__tmp_ws_src_rmf_traffic_rmf_traffic_include_rmf_traffic_detail_bidirectional_iterator.hpp>` (``/tmp/ws/src/rmf_traffic/rmf_traffic/include/rmf_traffic/detail/bidirectional_iterator.hpp``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /*
    * Copyright (C) 2019 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 RMF_TRAFFIC__DETAIL__BIDIRECTIONAL_ITERATOR_HPP
   #define RMF_TRAFFIC__DETAIL__BIDIRECTIONAL_ITERATOR_HPP
   
   #include <rmf_utils/impl_ptr.hpp>
   
   namespace rmf_traffic {
   namespace detail {
   
   //==============================================================================
   template<typename ElementType, typename ImplementationType, typename Friend>
   class bidirectional_iterator
   {
   public:
   
     using Element = ElementType;
     using Implementation = ImplementationType;
   
     Element& operator*() const;
   
     Element* operator->() const;
   
     bidirectional_iterator& operator++();
   
     bidirectional_iterator& operator--();
   
     bidirectional_iterator operator++(int);
   
     bidirectional_iterator operator--(int);
   
     bool operator==(const bidirectional_iterator& other) const;
   
     bool operator!=(const bidirectional_iterator& other) const;
   
     // Allow implicit conversion to const_iterator type
     operator bidirectional_iterator<const Element, Implementation,
       Friend>() const;
   
     // Allow typical copying and moving
     bidirectional_iterator(const bidirectional_iterator&) = default;
     bidirectional_iterator(bidirectional_iterator&&) = default;
     bidirectional_iterator& operator=(const bidirectional_iterator&) = default;
     bidirectional_iterator& operator=(bidirectional_iterator&&) = default;
   
     // Default constructor. This will leave the iterator uninitialized, so it is
     // UNDEFINED BEHAVIOR (most likely a segfault) to use it without using one of
     // the container's functions (like insert, find, begin, end, etc) to
     // initialize it first.
     bidirectional_iterator();
   
   private:
     bidirectional_iterator(ImplementationType impl);
     friend Friend;
     template<typename, typename, typename> friend class bidirectional_iterator;
     rmf_utils::impl_ptr<Implementation> _pimpl;
   };
   
   } // namespace detail
   } // namespace rmf_traffic
   
   #endif // RMF_TRAFFIC__DETAIL__BIDIRECTIONAL_ITERATOR_HPP