WriteParams.hpp

// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// 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 FASTDDS_RTPS_COMMON__WRITEPARAMS_HPP
#define FASTDDS_RTPS_COMMON__WRITEPARAMS_HPP
 
#include <memory>
 
#include <fastdds/rtps/common/OriginalWriterInfo.hpp>
#include <fastdds/rtps/common/SampleIdentity.hpp>
#include <fastdds/rtps/common/Time_t.hpp>
 
namespace eprosima {
namespace fastdds {
namespace rtps {
 
class FASTDDS_EXPORTED_API WriteParams
{
public:
 
    struct FASTDDS_EXPORTED_API UserWriteData
    {
        UserWriteData() = default;
 
        virtual ~UserWriteData() = default;
    };
 
    WriteParams& sample_identity(
            const SampleIdentity& sample_id)
    {
        sample_identity_ = sample_id;
        return *this;
    }
 
    WriteParams& sample_identity(
            SampleIdentity&& sample_id)
    {
        sample_identity_ = std::move(sample_id);
        return *this;
    }
 
    const SampleIdentity& sample_identity() const
    {
        return sample_identity_;
    }
 
    SampleIdentity& sample_identity()
    {
        return sample_identity_;
    }
 
    WriteParams& related_sample_identity(
            const SampleIdentity& sample_id)
    {
        related_sample_identity_ = sample_id;
        return *this;
    }
 
    WriteParams& related_sample_identity(
            SampleIdentity&& sample_id)
    {
        related_sample_identity_ = std::move(sample_id);
        return *this;
    }
 
    const SampleIdentity& related_sample_identity() const
    {
        return related_sample_identity_;
    }
 
    SampleIdentity& related_sample_identity()
    {
        return related_sample_identity_;
    }
 
    Time_t source_timestamp() const
    {
        return source_timestamp_;
    }
 
    Time_t& source_timestamp()
    {
        return source_timestamp_;
    }
 
    WriteParams& source_timestamp(
            const Time_t& timestamp)
    {
        source_timestamp_ = timestamp;
        return *this;
    }
 
    WriteParams& source_timestamp(
            Time_t&& timestamp)
    {
        source_timestamp_ = std::move(timestamp);
        return *this;
    }
 
    std::shared_ptr<UserWriteData> user_write_data() const
    {
        return user_write_data_;
    }
 
    WriteParams& user_write_data(
            std::shared_ptr<UserWriteData> write_data)
    {
        user_write_data_ = write_data;
        return *this;
    }
 
    bool has_more_replies() const
    {
        return has_more_replies_;
    }
 
    WriteParams& has_more_replies(
            bool more_replies)
    {
        has_more_replies_ = more_replies;
        return *this;
    }
 
    const OriginalWriterInfo& original_writer_info() const
    {
        return original_writer_info_;
    }
 
    OriginalWriterInfo& original_writer_info()
    {
        return original_writer_info_;
    }
 
    WriteParams& original_writer_info(
            const OriginalWriterInfo& original_writer)
    {
        original_writer_info_ = original_writer;
        return *this;
    }
 
    static WriteParams WRITE_PARAM_DEFAULT;
 
    static WriteParams write_params_default() noexcept
    {
        return WriteParams();
    }
 
private:
 
    class FASTDDS_EXPORTED_API UserWriteDataPtr : public std::shared_ptr<UserWriteData>
    {
    public:
 
        UserWriteDataPtr(
                std::shared_ptr<UserWriteData> ptr)
            : std::shared_ptr<UserWriteData>(ptr)
        {
        }
 
    };
 
    SampleIdentity sample_identity_;
    SampleIdentity related_sample_identity_;
    Time_t source_timestamp_{ -1, TIME_T_INFINITE_NANOSECONDS };
    UserWriteDataPtr user_write_data_{nullptr};
    bool has_more_replies_ = false;
    OriginalWriterInfo original_writer_info_;
};
 
}  // namespace rtps
}  // namespace fastdds
}  // namespace eprosima
 
#endif //FASTDDS_RTPS_COMMON__WRITEPARAMS_HPP