Program Listing for File DataWriter.hpp

↰ Return to documentation for file (/tmp/ws/src/fastrtps/include/dds/pub/DataWriter.hpp)

/*
 * Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Corp.
 * Copyright 2010, Real-Time Innovations, Inc.
 * Copyright 2019, 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 OMG_DDS_PUB_DATA_WRITER_HPP_
#define OMG_DDS_PUB_DATA_WRITER_HPP_

#include <dds/core/InstanceHandle.hpp>
//#include <dds/topic/Topic.hpp>
//#include <dds/topic/TopicInstance.hpp>
#include <dds/pub/Publisher.hpp>
#include <dds/pub/AnyDataWriter.hpp>

#include <dds/pub/detail/DataWriter.hpp>

namespace dds {
namespace pub {

template<typename T>
class DataWriter;

template<typename T>
class DataWriterListener;

template<typename T>
class DataWriter : public TAnyDataWriter<detail::DataWriter>
{
public:

    using Listener = DataWriterListener<T>;

    OMG_DDS_REF_TYPE_PROTECTED_DC(
        DataWriter,
        dds::pub::TAnyDataWriter,
        detail::DataWriter)

    OMG_DDS_IMPLICIT_REF_BASE(
        DataWriter)


    //    DataWriter(
    //            const Publisher& pub,
    //            const ::dds::topic::Topic<T>& topic);


    //    DataWriter(
    //            const Publisher& pub,
    //            const ::dds::topic::Topic<T>& topic,
    //            const qos::DataWriterQos& qos,
    //            DataWriterListener<T>* listener = nullptr,
    //            const dds::core::status::StatusMask& mask = ::dds::core::status::StatusMask::all());


    virtual ~DataWriter();
    //==========================================================================
    //== Write API

    OMG_DDS_API void write(
            const T& sample);

    OMG_DDS_API void write(
            const T& sample,
            const dds::core::Time& timestamp);

    OMG_DDS_API void write(
            const T& sample,
            const ::dds::core::InstanceHandle& instance);

    OMG_DDS_API void write(
            const T& data,
            const ::dds::core::InstanceHandle& instance,
            const dds::core::Time& timestamp);


    //    void write(
    //            const dds::topic::TopicInstance<T>& i);

    //    void write(
    //            const dds::topic::TopicInstance<T>& i,
    //            const dds::core::Time& timestamp);

    template<typename FWIterator>
    OMG_DDS_API void write(
            const FWIterator& begin,
            const FWIterator& end);

    template<typename FWIterator>
    OMG_DDS_API void write(
            const FWIterator& begin,
            const FWIterator& end,
            const dds::core::Time& timestamp);

    template<
        typename SamplesFWIterator,
        typename HandlesFWIterator>
    OMG_DDS_API void write(
            const SamplesFWIterator& data_begin,
            const SamplesFWIterator& data_end,
            const HandlesFWIterator& handle_begin,
            const HandlesFWIterator& handle_end);

    template<
        typename SamplesFWIterator,
        typename HandlesFWIterator>
    OMG_DDS_API void write(
            const SamplesFWIterator& data_begin,
            const SamplesFWIterator& data_end,
            const HandlesFWIterator& handle_begin,
            const HandlesFWIterator& handle_end,
            const dds::core::Time& timestamp);


    OMG_DDS_API DataWriter& operator <<(
            const T& data);

    OMG_DDS_API DataWriter& operator <<(
            const std::pair<T, dds::core::Time>& data);

    OMG_DDS_API DataWriter& operator <<(
            const std::pair<T, ::dds::core::InstanceHandle>& data);

    OMG_DDS_API DataWriter& operator <<(
            DataWriter& (*manipulator)(DataWriter&));
    //==========================================================================
    //== Instance Management

    OMG_DDS_API const ::dds::core::InstanceHandle register_instance(
            const T& key);

    OMG_DDS_API const ::dds::core::InstanceHandle register_instance(
            const T& key,
            const dds::core::Time& timestamp);

    OMG_DDS_API DataWriter& unregister_instance(
            const ::dds::core::InstanceHandle& i);

    OMG_DDS_API DataWriter& unregister_instance(
            const ::dds::core::InstanceHandle& i,
            const dds::core::Time& timestamp);

    OMG_DDS_API DataWriter& unregister_instance(
            const T& key);

    OMG_DDS_API DataWriter& unregister_instance(
            const T& key,
            const dds::core::Time& timestamp);

    OMG_DDS_API DataWriter& dispose_instance(
            const ::dds::core::InstanceHandle& i);

    OMG_DDS_API DataWriter& dispose_instance(
            const ::dds::core::InstanceHandle& i,
            const dds::core::Time& timestamp);

    OMG_DDS_API DataWriter& dispose_instance(
            const T& key);

    OMG_DDS_API DataWriter& dispose_instance(
            const T& key,
            const dds::core::Time& timestamp);

    //    dds::topic::TopicInstance<T>& key_value(
    //            dds::topic::TopicInstance<T>& i,
    //            const ::dds::core::InstanceHandle& h);

    OMG_DDS_API T& key_value(
            T& sample,
            const ::dds::core::InstanceHandle& h);

    OMG_DDS_API dds::core::InstanceHandle lookup_instance(
            const T& key);

    //==========================================================================
    //== QoS Management

    OMG_DDS_API DataWriter& operator <<(
            const qos::DataWriterQos& qos);


    //==========================================================================
    //== Entity Navigation

    //    const dds::topic::Topic<T>& topic() const;

    //==========================================================================
    //== Listeners Management

    OMG_DDS_API void listener(
            DataWriterListener<T>* listener,
            const ::dds::core::status::StatusMask& mask);

    OMG_DDS_API DataWriterListener<T>* listener() const;
};

} //namespace pub
} //namespace dds

#endif //OMG_DDS_PUB_DATA_WRITER_HPP_