| Fast DDS Version 3.3.0 Fast DDS

Loading...
Searching...
No Matches
WriterQos.hpp
1// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
19
20#ifndef FASTDDS_DDS_PUBLISHER_QOS__WRITERQOS_HPP
21#define FASTDDS_DDS_PUBLISHER_QOS__WRITERQOS_HPP
22
23#include <fastdds/dds/core/policy/QosPolicies.hpp>
24
25 namespace eprosima {
26 namespace fastdds {
27 namespace dds {
28
36 FASTDDS_TODO_BEFORE(4, 0, "Remove this class in favor of PublicationBuiltinTopicData");
37 class WriterQos
38{
39 public:
40
41 FASTDDS_EXPORTED_API WriterQos();
42 FASTDDS_EXPORTED_API virtual ~WriterQos();
43
44 bool operator ==(
45 const WriterQos& b) const
46 {
47 return (this->m_durability == b.m_durability) &&
48 (this->m_durabilityService == b.m_durabilityService) &&
49 (this->m_deadline == b.m_deadline) &&
50 (this->m_latencyBudget == b.m_latencyBudget) &&
51 (this->m_liveliness == b.m_liveliness) &&
52 (this->m_reliability == b.m_reliability) &&
53 (this->m_lifespan == b.m_lifespan) &&
54 (this->m_userData == b.m_userData) &&
55 (this->m_timeBasedFilter == b.m_timeBasedFilter) &&
56 (this->m_ownership == b.m_ownership) &&
57 (this->m_ownershipStrength == b.m_ownershipStrength) &&
58 (this->m_destinationOrder == b.m_destinationOrder) &&
59 (this->m_presentation == b.m_presentation) &&
60 (this->m_partition == b.m_partition) &&
61 (this->m_topicData == b.m_topicData) &&
62 (this->m_groupData == b.m_groupData) &&
63 (this->m_publishMode == b.m_publishMode) &&
64 (this->m_disablePositiveACKs == b.m_disablePositiveACKs) &&
65 (this->representation == b.representation) &&
66 (this->data_sharing == b.data_sharing);
67 }
68
70 DurabilityQosPolicy m_durability;
71
73 DurabilityServiceQosPolicy m_durabilityService;
74
76 DeadlineQosPolicy m_deadline;
77
79 LatencyBudgetQosPolicy m_latencyBudget;
80
82 LivelinessQosPolicy m_liveliness;
83
85 ReliabilityQosPolicy m_reliability;
86
88 LifespanQosPolicy m_lifespan;
89
91 UserDataQosPolicy m_userData;
92
94 TimeBasedFilterQosPolicy m_timeBasedFilter;
95
97 OwnershipQosPolicy m_ownership;
98
100 OwnershipStrengthQosPolicy m_ownershipStrength;
101
103 DestinationOrderQosPolicy m_destinationOrder;
104
106 PresentationQosPolicy m_presentation;
107
109 PartitionQosPolicy m_partition;
110
112 TopicDataQosPolicy m_topicData;
113
115 GroupDataQosPolicy m_groupData;
116
118 PublishModeQosPolicy m_publishMode;
119
121 DataRepresentationQosPolicy representation;
122
124 DisablePositiveACKsQosPolicy m_disablePositiveACKs;
125
127 DataSharingQosPolicy data_sharing;
128
130 bool disable_heartbeat_piggyback = false;
131
139 FASTDDS_EXPORTED_API void setQos(
140 const WriterQos& qos,
141 bool first_time);
142
149 FASTDDS_EXPORTED_API bool checkQos() const;
150
154 FASTDDS_EXPORTED_API bool canQosBeUpdated(
155 const WriterQos& qos) const;
156
160 void clear();
161};
162
163//FASTDDS_EXPORTED_API extern const WriterQos DATAWRITER_QOS_DEFAULT;
164
165} //namespace dds
166} //namespace fastdds
167} //namespace eprosima
168
169#endif // FASTDDS_DDS_PUBLISHER_QOS__WRITERQOS_HPP
eprosima::fastdds::dds::DataRepresentationQosPolicy
With multiple standard data Representations available, and vendor-specific extensions possible,...
Definition QosPolicies.hpp:2072
eprosima::fastdds::dds::DataSharingQosPolicy
Qos Policy to configure the data sharing.
Definition QosPolicies.hpp:2952
eprosima::fastdds::dds::DeadlineQosPolicy
DataReader expects a new sample updating the value of each instance at least once every deadline peri...
Definition QosPolicies.hpp:363
eprosima::fastdds::dds::DestinationOrderQosPolicy
Controls the criteria used to determine the logical order among changes made by Publisher entities to...
Definition QosPolicies.hpp:719
eprosima::fastdds::dds::DisablePositiveACKsQosPolicy
Class DisablePositiveACKsQosPolicy to disable sending of positive ACKs.
Definition QosPolicies.hpp:2224
eprosima::fastdds::dds::DurabilityQosPolicy
This policy expresses if the data should ‘outlive’ their writing time.
Definition QosPolicies.hpp:278
eprosima::fastdds::dds::DurabilityServiceQosPolicy
Specifies the configuration of the durability service.
Definition QosPolicies.hpp:1789
eprosima::fastdds::dds::LatencyBudgetQosPolicy
Specifies the maximum acceptable delay from the time the data is written until the data is inserted i...
Definition QosPolicies.hpp:416
eprosima::fastdds::dds::LifespanQosPolicy
Specifies the maximum duration of validity of the data written by the DataWriter.
Definition QosPolicies.hpp:1877
eprosima::fastdds::dds::LivelinessQosPolicy
Determines the mechanism and parameters used by the application to determine whether an Entity is “ac...
Definition QosPolicies.hpp:488
eprosima::fastdds::dds::OwnershipQosPolicy
Specifies whether it is allowed for multiple DataWriters to write the same instance of the data and i...
Definition QosPolicies.hpp:652
eprosima::fastdds::dds::OwnershipStrengthQosPolicy
Specifies the value of the “strength” used to arbitrate among multiple DataWriter objects that attemp...
Definition QosPolicies.hpp:1923
eprosima::fastdds::dds::PartitionQosPolicy
Set of strings that introduces a logical partition among the topics visible by the Publisher and Subs...
Definition QosPolicies.hpp:1286
eprosima::fastdds::dds::PresentationQosPolicy
Specifies how the samples representing changes to data instances are presented to the subscribing app...
Definition QosPolicies.hpp:1156
eprosima::fastdds::dds::PublishModeQosPolicy
Class PublishModeQosPolicy, defines the publication mode for a specific writer.
Definition QosPolicies.hpp:2020
eprosima::fastdds::dds::ReliabilityQosPolicy
Indicates the reliability of the endpoint.
Definition QosPolicies.hpp:570
eprosima::fastdds::dds::TimeBasedFilterQosPolicy
Filter that allows a DataReader to specify that it is interested only in (potentially) a subset of th...
Definition QosPolicies.hpp:1082
eprosima::fastdds::dds::WriterQos::m_lifespan
LifespanQosPolicy m_lifespan
Lifespan Qos, NOT implemented in the library.
Definition WriterQos.hpp:88
eprosima::fastdds::dds::WriterQos::~WriterQos
virtual FASTDDS_EXPORTED_API ~WriterQos()
eprosima::fastdds::dds::WriterQos::m_userData
UserDataQosPolicy m_userData
UserData Qos, NOT implemented in the library.
Definition WriterQos.hpp:91
eprosima::fastdds::dds::WriterQos::representation
DataRepresentationQosPolicy representation
Data Representation Qos, implemented in the library.
Definition WriterQos.hpp:121
eprosima::fastdds::dds::WriterQos::m_disablePositiveACKs
DisablePositiveACKsQosPolicy m_disablePositiveACKs
Disable positive acks QoS, implemented in the library.
Definition WriterQos.hpp:124
eprosima::fastdds::dds::WriterQos::WriterQos
FASTDDS_EXPORTED_API WriterQos()
eprosima::fastdds::dds::WriterQos::m_presentation
PresentationQosPolicy m_presentation
Presentation Qos, NOT implemented in the library.
Definition WriterQos.hpp:106
eprosima::fastdds::dds::WriterQos::m_publishMode
PublishModeQosPolicy m_publishMode
Publication Mode Qos, implemented in the library.
Definition WriterQos.hpp:118
eprosima::fastdds::dds::WriterQos::m_destinationOrder
DestinationOrderQosPolicy m_destinationOrder
Destination Order Qos, NOT implemented in the library.
Definition WriterQos.hpp:103
eprosima::fastdds::dds::WriterQos::m_ownership
OwnershipQosPolicy m_ownership
Ownership Qos, implemented in the library.
Definition WriterQos.hpp:97
eprosima::fastdds::dds::WriterQos::m_durability
DurabilityQosPolicy m_durability
Durability Qos, implemented in the library.
Definition WriterQos.hpp:70
eprosima::fastdds::dds::WriterQos::m_durabilityService
DurabilityServiceQosPolicy m_durabilityService
Durability Service Qos, NOT implemented in the library.
Definition WriterQos.hpp:73
eprosima::fastdds::dds::WriterQos::disable_heartbeat_piggyback
bool disable_heartbeat_piggyback
Disable heartbeat piggyback mechanism.
Definition WriterQos.hpp:130
eprosima::fastdds::dds::WriterQos::operator==
bool operator==(const WriterQos &b) const
Definition WriterQos.hpp:44
eprosima::fastdds::dds::WriterQos::m_ownershipStrength
OwnershipStrengthQosPolicy m_ownershipStrength
Owenership Strength Qos, implemented in the library.
Definition WriterQos.hpp:100
eprosima::fastdds::dds::WriterQos::canQosBeUpdated
FASTDDS_EXPORTED_API bool canQosBeUpdated(const WriterQos &qos) const
eprosima::fastdds::dds::WriterQos::m_partition
PartitionQosPolicy m_partition
Partition Qos, implemented in the library.
Definition WriterQos.hpp:109
eprosima::fastdds::dds::WriterQos::data_sharing
DataSharingQosPolicy data_sharing
Information for data sharing compatibility check.
Definition WriterQos.hpp:127
eprosima::fastdds::dds::WriterQos::clear
void clear()
eprosima::fastdds::dds::WriterQos::checkQos
FASTDDS_EXPORTED_API bool checkQos() const
Check if the Qos values are compatible between each other.
eprosima::fastdds::dds::WriterQos::m_latencyBudget
LatencyBudgetQosPolicy m_latencyBudget
Latency Budget Qos, NOT implemented in the library.
Definition WriterQos.hpp:79
eprosima::fastdds::dds::WriterQos::m_deadline
DeadlineQosPolicy m_deadline
Deadline Qos, implemented in the library.
Definition WriterQos.hpp:76
eprosima::fastdds::dds::WriterQos::m_liveliness
LivelinessQosPolicy m_liveliness
Liveliness Qos, implemented in the library.
Definition WriterQos.hpp:82
eprosima::fastdds::dds::WriterQos::m_topicData
TopicDataQosPolicy m_topicData
Topic Data Qos, NOT implemented in the library.
Definition WriterQos.hpp:112
eprosima::fastdds::dds::WriterQos::m_groupData
GroupDataQosPolicy m_groupData
Group Data Qos, NOT implemented in the library.
Definition WriterQos.hpp:115
eprosima::fastdds::dds::WriterQos::setQos
FASTDDS_EXPORTED_API void setQos(const WriterQos &qos, bool first_time)
Set Qos from another class.
eprosima::fastdds::dds::WriterQos::m_reliability
ReliabilityQosPolicy m_reliability
Reliability Qos, implemented in the library.
Definition WriterQos.hpp:85
eprosima::fastdds::dds::WriterQos::m_timeBasedFilter
TimeBasedFilterQosPolicy m_timeBasedFilter
Time Based Filter Qos, NOT implemented in the library.
Definition WriterQos.hpp:94
eprosima::fastdds::dds
Definition BuiltinTopicKey.hpp:26
eprosima::fastdds::dds::FASTDDS_TODO_BEFORE
FASTDDS_TODO_BEFORE(4, 0, "Remove 'hasChanged' and 'send_always_' as they were replaced by 'should_be_sent'.")
Class QosPolicy, base for all QoS policies defined for Writers and Readers.
eprosima::fastdds
eprosima
eProsima namespace.