OpenDDS  Snapshot(2023/04/28-20:55)
Public Member Functions | Private Attributes | List of all members
OpenDDS::DCPS::TopicQosBuilder Class Reference

#include <Qos_Helper.h>

Collaboration diagram for OpenDDS::DCPS::TopicQosBuilder:
Collaboration graph
[legend]

Public Member Functions

 TopicQosBuilder ()
 
const DDS::TopicQosqos () const
 
DDS::TopicQosqos ()
 
 operator const DDS::TopicQos & () const
 
 operator DDS::TopicQos & ()
 
TopicQosBuildertopic_data_value (const DDS::OctetSeq &value)
 
TopicQosBuilderdurability_kind (DDS::DurabilityQosPolicyKind kind)
 
TopicQosBuilderdurability_volatile ()
 
TopicQosBuilderdurability_transient_local ()
 
TopicQosBuilderdurability_transient ()
 
TopicQosBuilderdurability_persistent ()
 
TopicQosBuilderdurability_service_service_cleanup_delay (const DDS::Duration_t &delay)
 
TopicQosBuilderdurability_service_history_kind (DDS::HistoryQosPolicyKind kind)
 
TopicQosBuilderdurability_service_keep_last (int depth)
 
TopicQosBuilderdurability_service_keep_all ()
 
TopicQosBuilderdurability_service_history_depth (int depth)
 
TopicQosBuilderdurability_service_max_samples (int value)
 
TopicQosBuilderdurability_service_max_instances (int value)
 
TopicQosBuilderdurability_service_max_samples_per_instance (int value)
 
TopicQosBuilderdeadline_period (const DDS::Duration_t &duration)
 
TopicQosBuilderlatency_budget_duration (const DDS::Duration_t &duration)
 
TopicQosBuilderliveliness_kind (DDS::LivelinessQosPolicyKind kind)
 
TopicQosBuilderliveliness_automatic ()
 
TopicQosBuilderliveliness_manual_by_participant ()
 
TopicQosBuilderliveliness_manual_by_topic ()
 
TopicQosBuilderliveliness_lease_duration (const DDS::Duration_t &duration)
 
TopicQosBuilderreliability_kind (DDS::ReliabilityQosPolicyKind kind)
 
TopicQosBuilderreliability_best_effort ()
 
TopicQosBuilderreliability_reliable ()
 
TopicQosBuilderreliability_max_blocking_time (const DDS::Duration_t &duration)
 
TopicQosBuilderdestination_order_kind (DDS::DestinationOrderQosPolicyKind kind)
 
TopicQosBuilderdestination_order_by_reception_timestamp ()
 
TopicQosBuilderdestination_order_by_source_timestamp ()
 
TopicQosBuilderhistory_kind (DDS::HistoryQosPolicyKind kind)
 
TopicQosBuilderhistory_keep_last (int depth)
 
TopicQosBuilderhistory_keep_all ()
 
TopicQosBuilderhistory_depth (int depth)
 
TopicQosBuilderresource_limits_max_samples (int value)
 
TopicQosBuilderresource_limits_max_instances (int value)
 
TopicQosBuilderresource_limits_max_samples_per_instance (int value)
 
TopicQosBuildertransport_priority_value (int value)
 
TopicQosBuilderlifespan_duration (const DDS::Duration_t &duration)
 
TopicQosBuilderownership_kind (DDS::OwnershipQosPolicyKind kind)
 
TopicQosBuilderownership_shared ()
 
TopicQosBuilderownership_exclusive ()
 

Private Attributes

DDS::TopicQos qos_
 

Detailed Description

Definition at line 1124 of file Qos_Helper.h.

Constructor & Destructor Documentation

◆ TopicQosBuilder()

OpenDDS::DCPS::TopicQosBuilder::TopicQosBuilder ( )
inline

Definition at line 1126 of file Qos_Helper.h.

1127  {
1128  // topic_data
1129  qos_.durability = DurabilityQosPolicyBuilder();
1130  qos_.durability_service = DurabilityServiceQosPolicyBuilder();
1131  qos_.deadline = DeadlineQosPolicyBuilder();
1132  qos_.latency_budget = LatencyBudgetQosPolicyBuilder();
1133  qos_.liveliness = LivelinessQosPolicyBuilder();
1134  qos_.reliability = ReliabilityQosPolicyBuilder();
1135  qos_.destination_order = DestinationOrderQosPolicyBuilder();
1136  qos_.history = HistoryQosPolicyBuilder();
1137  qos_.resource_limits = ResourceLimitsQosPolicyBuilder();
1138  qos_.transport_priority = TransportPriorityQosPolicyBuilder();
1139  qos_.lifespan = LifespanQosPolicyBuilder();
1140  qos_.ownership = OwnershipQosPolicyBuilder();
1141  // representation
1142  }
LatencyBudgetQosPolicy latency_budget
LifespanQosPolicy lifespan
TransportPriorityQosPolicy transport_priority
ResourceLimitsQosPolicy resource_limits
DestinationOrderQosPolicy destination_order
DurabilityQosPolicy durability
DeadlineQosPolicy deadline
ReliabilityQosPolicy reliability
OwnershipQosPolicy ownership
HistoryQosPolicy history
LivelinessQosPolicy liveliness
DurabilityServiceQosPolicy durability_service

Member Function Documentation

◆ deadline_period()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::deadline_period ( const DDS::Duration_t duration)
inline

Definition at line 1234 of file Qos_Helper.h.

1235  {
1236  qos_.deadline.period = duration;
1237  return *this;
1238  }
DeadlineQosPolicy deadline

◆ destination_order_by_reception_timestamp()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::destination_order_by_reception_timestamp ( )
inline

Definition at line 1306 of file Qos_Helper.h.

References DDS::BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS.

1307  {
1309  return *this;
1310  }
DestinationOrderQosPolicyKind kind
DestinationOrderQosPolicy destination_order

◆ destination_order_by_source_timestamp()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::destination_order_by_source_timestamp ( )
inline

Definition at line 1312 of file Qos_Helper.h.

References DDS::BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS.

1313  {
1315  return *this;
1316  }
DestinationOrderQosPolicyKind kind
DestinationOrderQosPolicy destination_order

◆ destination_order_kind()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::destination_order_kind ( DDS::DestinationOrderQosPolicyKind  kind)
inline

Definition at line 1300 of file Qos_Helper.h.

1301  {
1302  qos_.destination_order.kind = kind;
1303  return *this;
1304  }
DestinationOrderQosPolicyKind kind
DestinationOrderQosPolicy destination_order

◆ durability_kind()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_kind ( DDS::DurabilityQosPolicyKind  kind)
inline

Definition at line 1155 of file Qos_Helper.h.

1156  {
1157  qos_.durability.kind = kind;
1158  return *this;
1159  }
DurabilityQosPolicyKind kind
DurabilityQosPolicy durability

◆ durability_persistent()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_persistent ( )
inline

Definition at line 1179 of file Qos_Helper.h.

References DDS::PERSISTENT_DURABILITY_QOS.

1180  {
1182  return *this;
1183  }
DurabilityQosPolicyKind kind
DurabilityQosPolicy durability

◆ durability_service_history_depth()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_service_history_depth ( int  depth)
inline

Definition at line 1210 of file Qos_Helper.h.

References history_depth().

1211  {
1213  return *this;
1214  }
DurabilityServiceQosPolicy durability_service

◆ durability_service_history_kind()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_service_history_kind ( DDS::HistoryQosPolicyKind  kind)
inline

Definition at line 1191 of file Qos_Helper.h.

References history_kind().

1192  {
1194  return *this;
1195  }
HistoryQosPolicyKind history_kind
DurabilityServiceQosPolicy durability_service

◆ durability_service_keep_all()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_service_keep_all ( )
inline

Definition at line 1204 of file Qos_Helper.h.

References history_kind(), and DDS::KEEP_ALL_HISTORY_QOS.

1205  {
1207  return *this;
1208  }
HistoryQosPolicyKind history_kind
DurabilityServiceQosPolicy durability_service

◆ durability_service_keep_last()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_service_keep_last ( int  depth)
inline

Definition at line 1197 of file Qos_Helper.h.

References history_kind(), and DDS::KEEP_LAST_HISTORY_QOS.

1198  {
1201  return *this;
1202  }
HistoryQosPolicyKind history_kind
DurabilityServiceQosPolicy durability_service

◆ durability_service_max_instances()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_service_max_instances ( int  value)
inline

Definition at line 1222 of file Qos_Helper.h.

References value.

1223  {
1225  return *this;
1226  }
const LogLevel::Value value
Definition: debug.cpp:61
DurabilityServiceQosPolicy durability_service

◆ durability_service_max_samples()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_service_max_samples ( int  value)
inline

Definition at line 1216 of file Qos_Helper.h.

References value.

1217  {
1219  return *this;
1220  }
const LogLevel::Value value
Definition: debug.cpp:61
DurabilityServiceQosPolicy durability_service

◆ durability_service_max_samples_per_instance()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_service_max_samples_per_instance ( int  value)
inline

Definition at line 1228 of file Qos_Helper.h.

References value.

1229  {
1231  return *this;
1232  }
const LogLevel::Value value
Definition: debug.cpp:61
DurabilityServiceQosPolicy durability_service

◆ durability_service_service_cleanup_delay()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_service_service_cleanup_delay ( const DDS::Duration_t delay)
inline

Definition at line 1185 of file Qos_Helper.h.

1186  {
1188  return *this;
1189  }
DurabilityServiceQosPolicy durability_service

◆ durability_transient()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_transient ( )
inline

Definition at line 1173 of file Qos_Helper.h.

References DDS::TRANSIENT_DURABILITY_QOS.

1174  {
1176  return *this;
1177  }
DurabilityQosPolicyKind kind
DurabilityQosPolicy durability

◆ durability_transient_local()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_transient_local ( )
inline

Definition at line 1167 of file Qos_Helper.h.

References DDS::TRANSIENT_LOCAL_DURABILITY_QOS.

1168  {
1170  return *this;
1171  }
DurabilityQosPolicyKind kind
DurabilityQosPolicy durability

◆ durability_volatile()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::durability_volatile ( )
inline

Definition at line 1161 of file Qos_Helper.h.

References DDS::VOLATILE_DURABILITY_QOS.

1162  {
1164  return *this;
1165  }
DurabilityQosPolicyKind kind
DurabilityQosPolicy durability

◆ history_depth()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::history_depth ( int  depth)
inline

Definition at line 1337 of file Qos_Helper.h.

Referenced by durability_service_history_depth().

1338  {
1339  qos_.history.depth = depth;
1340  return *this;
1341  }
HistoryQosPolicy history

◆ history_keep_all()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::history_keep_all ( )
inline

Definition at line 1331 of file Qos_Helper.h.

References DDS::KEEP_ALL_HISTORY_QOS.

1332  {
1334  return *this;
1335  }
HistoryQosPolicyKind kind
HistoryQosPolicy history

◆ history_keep_last()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::history_keep_last ( int  depth)
inline

Definition at line 1324 of file Qos_Helper.h.

References DDS::KEEP_LAST_HISTORY_QOS.

1325  {
1327  qos_.history.depth = depth;
1328  return *this;
1329  }
HistoryQosPolicyKind kind
HistoryQosPolicy history

◆ history_kind()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::history_kind ( DDS::HistoryQosPolicyKind  kind)
inline

Definition at line 1318 of file Qos_Helper.h.

Referenced by durability_service_history_kind(), durability_service_keep_all(), and durability_service_keep_last().

1319  {
1320  qos_.history.kind = kind;
1321  return *this;
1322  }
HistoryQosPolicyKind kind
HistoryQosPolicy history

◆ latency_budget_duration()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::latency_budget_duration ( const DDS::Duration_t duration)
inline

Definition at line 1240 of file Qos_Helper.h.

1241  {
1242  qos_.latency_budget.duration = duration;
1243  return *this;
1244  }
LatencyBudgetQosPolicy latency_budget

◆ lifespan_duration()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::lifespan_duration ( const DDS::Duration_t duration)
inline

Definition at line 1367 of file Qos_Helper.h.

1368  {
1369  qos_.lifespan.duration = duration;
1370  return *this;
1371  }
LifespanQosPolicy lifespan

◆ liveliness_automatic()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::liveliness_automatic ( )
inline

Definition at line 1252 of file Qos_Helper.h.

References DDS::AUTOMATIC_LIVELINESS_QOS.

1253  {
1255  return *this;
1256  }
LivelinessQosPolicyKind kind
LivelinessQosPolicy liveliness

◆ liveliness_kind()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::liveliness_kind ( DDS::LivelinessQosPolicyKind  kind)
inline

Definition at line 1246 of file Qos_Helper.h.

1247  {
1248  qos_.liveliness.kind = kind;
1249  return *this;
1250  }
LivelinessQosPolicyKind kind
LivelinessQosPolicy liveliness

◆ liveliness_lease_duration()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::liveliness_lease_duration ( const DDS::Duration_t duration)
inline

Definition at line 1270 of file Qos_Helper.h.

1271  {
1272  qos_.liveliness.lease_duration = duration;
1273  return *this;
1274  }
LivelinessQosPolicy liveliness

◆ liveliness_manual_by_participant()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::liveliness_manual_by_participant ( )
inline

Definition at line 1258 of file Qos_Helper.h.

References DDS::MANUAL_BY_PARTICIPANT_LIVELINESS_QOS.

1259  {
1261  return *this;
1262  }
LivelinessQosPolicyKind kind
LivelinessQosPolicy liveliness

◆ liveliness_manual_by_topic()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::liveliness_manual_by_topic ( )
inline

Definition at line 1264 of file Qos_Helper.h.

References DDS::MANUAL_BY_TOPIC_LIVELINESS_QOS.

1265  {
1267  return *this;
1268  }
LivelinessQosPolicyKind kind
LivelinessQosPolicy liveliness

◆ operator const DDS::TopicQos &()

OpenDDS::DCPS::TopicQosBuilder::operator const DDS::TopicQos & ( ) const
inline

Definition at line 1146 of file Qos_Helper.h.

1146 { return qos_; }

◆ operator DDS::TopicQos &()

OpenDDS::DCPS::TopicQosBuilder::operator DDS::TopicQos & ( )
inline

Definition at line 1147 of file Qos_Helper.h.

1147 { return qos_; }

◆ ownership_exclusive()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::ownership_exclusive ( )
inline

Definition at line 1385 of file Qos_Helper.h.

References DDS::EXCLUSIVE_OWNERSHIP_QOS.

1386  {
1388  return *this;
1389  }
OwnershipQosPolicyKind kind
OwnershipQosPolicy ownership

◆ ownership_kind()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::ownership_kind ( DDS::OwnershipQosPolicyKind  kind)
inline

Definition at line 1373 of file Qos_Helper.h.

1374  {
1375  qos_.ownership.kind = kind;
1376  return *this;
1377  }
OwnershipQosPolicyKind kind
OwnershipQosPolicy ownership

◆ ownership_shared()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::ownership_shared ( )
inline

Definition at line 1379 of file Qos_Helper.h.

References DDS::SHARED_OWNERSHIP_QOS.

1380  {
1382  return *this;
1383  }
OwnershipQosPolicyKind kind
OwnershipQosPolicy ownership

◆ qos() [1/2]

const DDS::TopicQos& OpenDDS::DCPS::TopicQosBuilder::qos ( void  ) const
inline

Definition at line 1144 of file Qos_Helper.h.

1144 { return qos_; }

◆ qos() [2/2]

DDS::TopicQos& OpenDDS::DCPS::TopicQosBuilder::qos ( void  )
inline

Definition at line 1145 of file Qos_Helper.h.

1145 { return qos_; }

◆ reliability_best_effort()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::reliability_best_effort ( )
inline

Definition at line 1282 of file Qos_Helper.h.

References DDS::BEST_EFFORT_RELIABILITY_QOS.

1283  {
1285  return *this;
1286  }
ReliabilityQosPolicyKind kind
ReliabilityQosPolicy reliability

◆ reliability_kind()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::reliability_kind ( DDS::ReliabilityQosPolicyKind  kind)
inline

Definition at line 1276 of file Qos_Helper.h.

1277  {
1278  qos_.reliability.kind = kind;
1279  return *this;
1280  }
ReliabilityQosPolicyKind kind
ReliabilityQosPolicy reliability

◆ reliability_max_blocking_time()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::reliability_max_blocking_time ( const DDS::Duration_t duration)
inline

Definition at line 1294 of file Qos_Helper.h.

1295  {
1296  qos_.reliability.max_blocking_time = duration;
1297  return *this;
1298  }
ReliabilityQosPolicy reliability

◆ reliability_reliable()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::reliability_reliable ( )
inline

Definition at line 1288 of file Qos_Helper.h.

References DDS::RELIABLE_RELIABILITY_QOS.

1289  {
1291  return *this;
1292  }
ReliabilityQosPolicyKind kind
ReliabilityQosPolicy reliability

◆ resource_limits_max_instances()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::resource_limits_max_instances ( int  value)
inline

Definition at line 1349 of file Qos_Helper.h.

References value.

1350  {
1352  return *this;
1353  }
const LogLevel::Value value
Definition: debug.cpp:61
ResourceLimitsQosPolicy resource_limits

◆ resource_limits_max_samples()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::resource_limits_max_samples ( int  value)
inline

Definition at line 1343 of file Qos_Helper.h.

References value.

1344  {
1346  return *this;
1347  }
const LogLevel::Value value
Definition: debug.cpp:61
ResourceLimitsQosPolicy resource_limits

◆ resource_limits_max_samples_per_instance()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::resource_limits_max_samples_per_instance ( int  value)
inline

Definition at line 1355 of file Qos_Helper.h.

References value.

1356  {
1358  return *this;
1359  }
const LogLevel::Value value
Definition: debug.cpp:61
ResourceLimitsQosPolicy resource_limits

◆ topic_data_value()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::topic_data_value ( const DDS::OctetSeq value)
inline

Definition at line 1149 of file Qos_Helper.h.

References value.

1150  {
1152  return *this;
1153  }
const LogLevel::Value value
Definition: debug.cpp:61
TopicDataQosPolicy topic_data

◆ transport_priority_value()

TopicQosBuilder& OpenDDS::DCPS::TopicQosBuilder::transport_priority_value ( int  value)
inline

Definition at line 1361 of file Qos_Helper.h.

References value.

1362  {
1364  return *this;
1365  }
const LogLevel::Value value
Definition: debug.cpp:61
TransportPriorityQosPolicy transport_priority

Member Data Documentation

◆ qos_

DDS::TopicQos OpenDDS::DCPS::TopicQosBuilder::qos_
private

Definition at line 1392 of file Qos_Helper.h.


The documentation for this class was generated from the following file: