gz/transport/log/Batch.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 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_TRANSPORT_LOG_BATCH_HH_
#define GZ_TRANSPORT_LOG_BATCH_HH_
 
#include <memory>
 
#include <gz/transport/config.hh>
#include <gz/transport/log/Export.hh>
#include <gz/transport/log/MsgIter.hh>
 
namespace ignition::transport::log
{
  // Inline bracket to help doxygen filtering.
  inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
  //
  class BatchPrivate;
  class Log;
 
  class IGNITION_TRANSPORT_LOG_VISIBLE Batch
  {
    public: Batch();
 
    public: Batch(Batch &&_old);  // NOLINT
 
    public: Batch& operator=(Batch &&_other); // NOLINT
 
    public: ~Batch();
 
    public: using iterator = MsgIter;
 
    public: iterator begin();
 
    public: iterator end();
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
    private: std::unique_ptr<BatchPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
 
    private: Batch(
        std::unique_ptr<BatchPrivate> &&_pimpl);  // NOLINT(build/c++11)
 
    friend class Log;
  };
  }
}
#endif