MsgIter.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_TRANSPORT_LOG_MSGITER_HH_
#define IGNITION_TRANSPORT_LOG_MSGITER_HH_

#include <memory>

#include <ignition/transport/config.hh>
#include <ignition/transport/log/Export.hh>
#include <ignition/transport/log/Message.hh>

namespace ignition
{
  namespace transport
  {
    namespace log
    {
      // Inline bracket to help doxygen filtering.
      inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
      //
      class MsgIterPrivate;
      class Log;

      class IGNITION_TRANSPORT_LOG_VISIBLE MsgIter
      {
        public: MsgIter();

        // TODO(anyone)
        // public: MsgIter(const MsgIter &_orig);

        public: MsgIter(MsgIter &&_orig);  // NOLINT

        public: ~MsgIter();

        // public: MsgIter &operator=(const MsgIter &_orig);

        public: MsgIter &operator++();

        // TODO(anyone)
        // public: MsgIter operator++(int);

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

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

        public: MsgIter& operator=(MsgIter &&_other); // NOLINT

        public: const Message &operator*() const;

        public: const Message *operator->() const;

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
        public: std::unique_ptr<MsgIterPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif

        private: MsgIter(
            std::unique_ptr<MsgIterPrivate> &&_pimpl);  // NOLINT(build/c++11)

        friend class Batch;
      };
      }
    }
  }
}
#endif