#include <DataWriter.hpp>
Inheritance diagram for DataWriter< T, DELEGATE >:
Detailed Description
template<typename T, template< typename Q > class DELEGATE>
class dds::pub::DataWriter< T, DELEGATE >
Definition at line 34 of file DataWriter.hpp.
Member Typedef Documentation
| typedef tdds::core::Entity< DELEGATE<T> > BASE_T |
Reimplemented from Entity< DELEGATE< T > >.
Definition at line 40 of file DataWriter.hpp.
| typedef ::dds::core::smart_ptr_traits< DELEGATE<T> >::ref_type DELEGATE_REF_T |
Reimplemented from Entity< DELEGATE< T > >.
Definition at line 40 of file DataWriter.hpp.
| typedef DELEGATE<T> DELEGATE_T |
Reimplemented from Entity< DELEGATE< T > >.
Definition at line 40 of file DataWriter.hpp.
| typedef ::dds::core::smart_ptr_traits< DELEGATE<T> >::weak_ref_type DELEGATE_WEAK_REF_T |
Reimplemented from Entity< DELEGATE< T > >.
Definition at line 40 of file DataWriter.hpp.
| typedef dds::pub::DataWriterListener<T> Listener |
Definition at line 36 of file DataWriter.hpp.
Definition at line 37 of file DataWriter.hpp.
Constructor & Destructor Documentation
| DataWriter | ( | DELEGATE_T * | p | ) | [inline, explicit] |
Definition at line 40 of file DataWriter.hpp.
| DataWriter | ( | const DELEGATE_REF_T & | ref | ) | [inline, explicit] |
Definition at line 40 of file DataWriter.hpp.
| DataWriter | ( | const H__ & | h | ) | [inline] |
Definition at line 40 of file DataWriter.hpp.
| DataWriter | ( | ) | [inline] |
Definition at line 40 of file DataWriter.hpp.
| ~DataWriter | ( | ) | [inline] |
Definition at line 42 of file DataWriter.hpp.
Member Function Documentation
| void assert_liveliness | ( | ) | [inline] |
Definition at line 306 of file DataWriter.hpp.
| void dispose_instance | ( | const dds::core::InstanceHandle & | i | ) | [inline] |
Definition at line 162 of file DataWriter.hpp.
| void dispose_instance | ( | const dds::core::InstanceHandle & | i, | |
| const dds::core::Time & | ts | |||
| ) | [inline] |
Definition at line 166 of file DataWriter.hpp.
| dds::topic::TopicInstance<T>& key_value | ( | dds::topic::TopicInstance< T > & | i, | |
| const dds::core::InstanceHandle & | h | |||
| ) | [inline] |
This operation can be used to retrieve the instance key that corresponds to an instance_handle. The operation will only fill the fields that form the key inside the key_holder instance. This operation may raise a BadParameter exception if the InstanceHandle does not correspond to an existing data-object known to the DataWriter. If the implementation is not able to check invalid handles, then the result in this situation is unspecified.
Definition at line 180 of file DataWriter.hpp.
| T& key_value | ( | T & | sample, | |
| const dds::core::InstanceHandle & | h | |||
| ) | [inline] |
This operation can be used to retrieve the instance key that corresponds to an instance_handle. The operation will only fill the fields that form the key inside the key_holder instance. This operation may raise a BadParameter exception if the InstanceHandle does not correspond to an existing data-object known to the DataWriter. If the implementation is not able to check invalid handles, then the result in this situation is unspecified.
Definition at line 194 of file DataWriter.hpp.
| void listener | ( | DataWriterListener< T > * | the_listener, | |
| const dds::core::status::StatusMask & | mask | |||
| ) | [inline] |
By virtue of extending Entity, a DataWriter can be attached to a Listener at creation time or later by using the listener operation. The attached Listener must be a DataWriterListener.
- Parameters:
-
listener the data writer listener
Definition at line 269 of file DataWriter.hpp.
| DataWriterListener<T>* listener | ( | ) | const [inline] |
Return the listener currently associated with this DataWriter.
- Returns:
- the
DataWriterListener.
Definition at line 280 of file DataWriter.hpp.
| const dds::core::status::LivelinessLostStatus liveliness_lost_status | ( | ) | [inline] |
Definition at line 287 of file DataWriter.hpp.
| const dds::core::InstanceHandle lookup_instance | ( | const T & | key | ) | [inline] |
This operation takes as a parameter an instance and returns a handle that can be used in subsequent operations that accept an instance handle as an argument. The instance parameter is only used for the purpose of examining the fields that define the key. This operation does not register the instance in question. If the instance has not been previously registered, or if for any other reason the Service is unable to provide an instance handle, the Service will return a TopicInstance whose handle will be set to the HANDLE_NIL value.
Definition at line 208 of file DataWriter.hpp.
| const dds::topic::SubscriptionBuiltinTopicData matched_subscription_data | ( | const dds::core::InstanceHandle & | h | ) | [inline] |
This operation retrieves information on a subscription that is currently ÒassociatedÓ with the DataWriter; that is, a subscription with a matching Topic and compatible QoS that the application has not indicated should be ÒignoredÓ by means of the DomainParticipant ignore_subscription operation. The subscription_handle must correspond to a subscription currently associated with the DataWriter, otherwise the operation will fail and throw a BadParameterError. The operation matched_subscriptions can be used to find the subscriptions that are currently matched with the DataWriter.
The operation may also fail if the infrastructure does not hold the information necessary to fill in the subscription_data. In this case the operation will throw UnsupportedError.
Definition at line 361 of file DataWriter.hpp.
| dds::core::InstanceHandleSeq& matched_subscriptions | ( | dds::core::InstanceHandleSeq & | subs | ) | [inline] |
This operation retrieves the list of subscriptions currently "associated" with the DataWriter; that is, subscriptions that have a matching Topic and compatible QoS that the application has not indicated should be "ignored" by means of the DomainParticipant ignore_subscription operation. The handles returned in the "subscription_handles" list are the ones that are used by the DDS implementation to locally identify the corresponding matched DataReader entities. These handles match the ones that appear in the "instance_handle" field of the SampleInfo when reading the "DCPSSubscriptions" builtin topic. The operation may fail if the infrastructure does not locally maintain the connectivity information.
Definition at line 341 of file DataWriter.hpp.
| const dds::core::InstanceHandleSeq matched_subscriptions | ( | ) | [inline] |
This operation retrieves the list of subscriptions currently "associated" with the DataWriter; that is, subscriptions that have a matching Topic and compatible QoS that the application has not indicated should be "ignored" by means of the DomainParticipant ignore_subscription operation. The handles returned in the "subscription_handles" list are the ones that are used by the DDS implementation to locally identify the corresponding matched DataReader entities. These handles match the ones that appear in the "instance_handle" field of the SampleInfo when reading the "DCPSSubscriptions" builtin topic. The operation may fail if the infrastructure does not locally maintain the connectivity information.
Definition at line 325 of file DataWriter.hpp.
| const dds::core::status::OfferedDeadlineMissedStatus offered_deadlined_missed_status | ( | ) | [inline] |
Definition at line 291 of file DataWriter.hpp.
| const dds::core::status::OfferedIncompatibleQosStatus offered_incompatible_qos_staus | ( | ) | [inline] |
Definition at line 295 of file DataWriter.hpp.
| void operator<< | ( | const DATA & | data | ) | [inline] |
Definition at line 138 of file DataWriter.hpp.
| DataWriter& operator<< | ( | const dds::pub::qos::DataWriterQos & | the_qos | ) | [inline] |
Definition at line 225 of file DataWriter.hpp.
| DataWriter& operator= | ( | const T__ & | rhs | ) | [inline] |
Reimplemented from Entity< DELEGATE< T > >.
Definition at line 40 of file DataWriter.hpp.
| const DataWriter& operator>> | ( | dds::pub::qos::DataWriterQos & | the_qos | ) | const [inline] |
Definition at line 230 of file DataWriter.hpp.
| const dds::core::status::PublicationMatchedStatus publication_matched_status | ( | ) | [inline] |
Definition at line 299 of file DataWriter.hpp.
| const dds::pub::qos::DataWriterQos qos | ( | ) | const [inline] |
Definition at line 217 of file DataWriter.hpp.
| void qos | ( | const dds::pub::qos::DataWriterQos & | the_qos | ) | [inline] |
Definition at line 221 of file DataWriter.hpp.
| const dds::core::InstanceHandle register_instance | ( | const T & | key | ) | [inline] |
Definition at line 144 of file DataWriter.hpp.
| const dds::core::InstanceHandle register_instance | ( | const T & | key, | |
| const dds::core::Time & | ts | |||
| ) | [inline] |
Definition at line 148 of file DataWriter.hpp.
| StatusCondition status_condition | ( | ) | const [inline] |
This operation allows access to the StatusCondition (Section 7.1.2.1.9, ÒStatusCondition Class) associated with the Entity. The returned condition can then be added to a WaitSet (Section 7.1.2.1.6, WaitSet Class) so that the application can wait for specific status changes that affect the Entity.
- Returns:
- the status condition
Definition at line 54 of file DataWriter.hpp.
| dds::topic::Topic<T> topic | ( | ) | const [inline] |
Definition at line 238 of file DataWriter.hpp.
| void unregister_instance | ( | const dds::core::InstanceHandle & | i, | |
| const dds::core::Time & | ts | |||
| ) | [inline] |
Definition at line 157 of file DataWriter.hpp.
| void unregister_instance | ( | const dds::core::InstanceHandle & | i | ) | [inline] |
Definition at line 153 of file DataWriter.hpp.
| void wait_for_acknowledgments | ( | const dds::core::Duration & | timeout | ) | [inline] |
This operation blocks the calling thread until either all data written by the reliable DataWriter entities is acknowledged by all matched reliable DataReader entities, or else the duration specified by the max_wait parameter elapses, whichever happens first. A normal return indicates that all the samples written have been acknowledged by all reliable matched data readers; A TimeoutError indicates that max_wait elapsed before all the data was acknowledged.
Definition at line 255 of file DataWriter.hpp.
| void write | ( | const T & | sample | ) | [inline] |
Definition at line 61 of file DataWriter.hpp.
| void write | ( | const T & | data, | |
| const dds::core::InstanceHandle & | instance | |||
| ) | [inline] |
Definition at line 69 of file DataWriter.hpp.
| void write | ( | const dds::topic::TopicInstance< T > & | i | ) | [inline] |
Definition at line 79 of file DataWriter.hpp.
| void write | ( | const FWIterator & | begin, | |
| const FWIterator & | end, | |||
| const dds::core::Time & | timestamp | |||
| ) | [inline] |
Definition at line 100 of file DataWriter.hpp.
| void write | ( | const dds::topic::TopicInstance< T > & | i, | |
| const dds::core::Time & | timestamp | |||
| ) | [inline] |
Definition at line 83 of file DataWriter.hpp.
| void write | ( | const SamplesFWIterator & | data_begin, | |
| const SamplesFWIterator & | data_end, | |||
| const HandlesFWIterator & | handle_begin, | |||
| const HandlesFWIterator & | handle_end | |||
| ) | [inline] |
Write a series of samples and their parallel instance handles.
Definition at line 112 of file DataWriter.hpp.
| void write | ( | const T & | data, | |
| const dds::core::InstanceHandle & | instance, | |||
| const dds::core::Time & | timestamp | |||
| ) | [inline] |
Definition at line 73 of file DataWriter.hpp.
| void write | ( | const T & | sample, | |
| const dds::core::Time & | timestamp | |||
| ) | [inline] |
Definition at line 65 of file DataWriter.hpp.
| void write | ( | const FWIterator & | begin, | |
| const FWIterator & | end | |||
| ) | [inline] |
Write a series of samples or TopicInstances (determined by the template specialization).
Definition at line 92 of file DataWriter.hpp.
| void write | ( | const SamplesFWIterator & | data_begin, | |
| const SamplesFWIterator & | data_end, | |||
| const HandlesFWIterator & | handle_begin, | |||
| const HandlesFWIterator & | handle_end, | |||
| const dds::core::Time & | timestamp | |||
| ) | [inline] |
Write a series of samples and their parallel instance handles.
Definition at line 126 of file DataWriter.hpp.
The documentation for this class was generated from the following file:
- src/hpp/dds/pub/DataWriter.hpp
