AnyDataReader.hpp

Go to the documentation of this file.

#ifndef OMG_TDDS_SUB_ANY_DATA_READER_HPP_
#define OMG_TDDS_SUB_ANY_DATA_READER_HPP_
/* Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Corp.
 * Copyright 2010, Real-Time Innovations, Inc.
 * All rights reserved.
 *
 * 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.
 */

#include <dds/core/Entity.hpp>
#include <dds/sub/Subscriber.hpp>
#include <dds/sub/qos/DataReaderQos.hpp>
#include <dds/topic/TopicDescription.hpp>

namespace dds
{
namespace sub
{

class AnyDataReader;

}
}

class dds::sub::AnyDataReader : public dds::core::Entity
{
public:
    OMG_DDS_REF_TYPE_PROTECTED_DC(AnyDataReader, dds::core::Entity)
    OMG_DDS_IMPLICIT_REF_BASE(AnyDataReader)

    
    virtual ~AnyDataReader();
    //==========================================================================
    // -- Entity Navigation API

    const dds::sub::Subscriber& subscriber() const;

    const dds::topic::TopicDescription& topic_description() const;



    void wait_for_historical_data(const dds::core::Duration& timeout);

#ifdef DOXYGEN_FOR_ISOCPP2
    /*
     * The above macro is never (and must never) be defined in normal compilation.
     *
     * The following code is for documenting proprietary API only.
     */


    void wait_for_historical_data_w_condition(const std::string& filter_expression,
                                              const std::vector<std::string>& filter_parameters,
                                              const dds::core::Time& min_source_timestamp,
                                              const dds::core::Time& max_source_timestamp,
                                              const dds::core::policy::ResourceLimits& resource_limits,
                                              const dds::core::Duration& timeout);
#endif /* DOXYGEN_FOR_ISOCPP2 */


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

    dds::sub::qos::DataReaderQos
    qos() const;

    void qos(const dds::sub::qos::DataReaderQos& qos);

    AnyDataReader& operator << (const dds::sub::qos::DataReaderQos& qos);

    const AnyDataReader& operator >> (dds::sub::qos::DataReaderQos& qos) const;


    //========================================================================
    // -- Status API
    dds::core::status::LivelinessChangedStatus
    liveliness_changed_status();

    dds::core::status::SampleRejectedStatus
    sample_rejected_status();

    dds::core::status::SampleLostStatus
    sample_lost_status();

    dds::core::status::RequestedDeadlineMissedStatus
    requested_deadline_missed_status();

    dds::core::status::RequestedIncompatibleQosStatus
    requested_incompatible_qos_status();

    dds::core::status::SubscriptionMatchedStatus
    subscription_matched_status();

};


#endif /* OMG_TDDS_SUB_ANY_DATA_READER_HPP_ */