OpenDDS  Snapshot(2023/04/07-19:43)
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 ()
 
 TopicQosBuilder (const DDS::TopicQos &qos)
 
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 1056 of file Qos_Helper.h.

Constructor & Destructor Documentation

◆ TopicQosBuilder() [1/2]

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

Definition at line 1058 of file Qos_Helper.h.

1059  {
1060  // topic_data
1061  qos_.durability = DurabilityQosPolicyBuilder();
1062  qos_.durability_service = DurabilityServiceQosPolicyBuilder();
1063  qos_.deadline = DeadlineQosPolicyBuilder();
1064  qos_.latency_budget = LatencyBudgetQosPolicyBuilder();
1065  qos_.liveliness = LivelinessQosPolicyBuilder();
1066  qos_.reliability = ReliabilityQosPolicyBuilder();
1067  qos_.destination_order = DestinationOrderQosPolicyBuilder();
1068  qos_.history = HistoryQosPolicyBuilder();
1069  qos_.resource_limits = ResourceLimitsQosPolicyBuilder();
1070  qos_.transport_priority = TransportPriorityQosPolicyBuilder();
1071  qos_.lifespan = LifespanQosPolicyBuilder();
1072  qos_.ownership = OwnershipQosPolicyBuilder();
1073  // representation
1074  }
LivelinessQosPolicy liveliness
OwnershipQosPolicy ownership
DeadlineQosPolicy deadline
ReliabilityQosPolicy reliability
HistoryQosPolicy history
DurabilityQosPolicy durability
TransportPriorityQosPolicy transport_priority
ResourceLimitsQosPolicy resource_limits
LifespanQosPolicy lifespan
DurabilityServiceQosPolicy durability_service
DestinationOrderQosPolicy destination_order
LatencyBudgetQosPolicy latency_budget

◆ TopicQosBuilder() [2/2]

OpenDDS::DCPS::TopicQosBuilder::TopicQosBuilder ( const DDS::TopicQos qos)
inlineexplicit

Definition at line 1076 of file Qos_Helper.h.

1077  : qos_(qos)
1078  {}

Member Function Documentation

◆ deadline_period()

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

Definition at line 1170 of file Qos_Helper.h.

1171  {
1172  qos_.deadline.period = duration;
1173  return *this;
1174  }
DeadlineQosPolicy deadline

◆ destination_order_by_reception_timestamp()

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

Definition at line 1242 of file Qos_Helper.h.

References DDS::BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS.

1243  {
1245  return *this;
1246  }
DestinationOrderQosPolicyKind kind
DestinationOrderQosPolicy destination_order

◆ destination_order_by_source_timestamp()

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

Definition at line 1248 of file Qos_Helper.h.

References DDS::BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS.

1249  {
1251  return *this;
1252  }
DestinationOrderQosPolicyKind kind
DestinationOrderQosPolicy destination_order

◆ destination_order_kind()

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

Definition at line 1236 of file Qos_Helper.h.

1237  {
1238  qos_.destination_order.kind = kind;
1239  return *this;
1240  }
DestinationOrderQosPolicyKind kind
DestinationOrderQosPolicy destination_order

◆ durability_kind()

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

Definition at line 1091 of file Qos_Helper.h.

1092  {
1093  qos_.durability.kind = kind;
1094  return *this;
1095  }
DurabilityQosPolicyKind kind
DurabilityQosPolicy durability

◆ durability_persistent()

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

Definition at line 1115 of file Qos_Helper.h.

References DDS::PERSISTENT_DURABILITY_QOS.

1116  {
1118  return *this;
1119  }
DurabilityQosPolicyKind kind
DurabilityQosPolicy durability

◆ durability_service_history_depth()

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

Definition at line 1146 of file Qos_Helper.h.

References history_depth().

1147  {
1149  return *this;
1150  }
DurabilityServiceQosPolicy durability_service

◆ durability_service_history_kind()

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

Definition at line 1127 of file Qos_Helper.h.

References history_kind().

1128  {
1130  return *this;
1131  }
HistoryQosPolicyKind history_kind
DurabilityServiceQosPolicy durability_service

◆ durability_service_keep_all()

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

Definition at line 1140 of file Qos_Helper.h.

References history_kind(), and DDS::KEEP_ALL_HISTORY_QOS.

1141  {
1143  return *this;
1144  }
HistoryQosPolicyKind history_kind
DurabilityServiceQosPolicy durability_service

◆ durability_service_keep_last()

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

Definition at line 1133 of file Qos_Helper.h.

References history_kind(), and DDS::KEEP_LAST_HISTORY_QOS.

1134  {
1137  return *this;
1138  }
HistoryQosPolicyKind history_kind
DurabilityServiceQosPolicy durability_service

◆ durability_service_max_instances()

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

Definition at line 1158 of file Qos_Helper.h.

References value.

1159  {
1161  return *this;
1162  }
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 1152 of file Qos_Helper.h.

References value.

1153  {
1155  return *this;
1156  }
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 1164 of file Qos_Helper.h.

References value.

1165  {
1167  return *this;
1168  }
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 1121 of file Qos_Helper.h.

1122  {
1124  return *this;
1125  }
DurabilityServiceQosPolicy durability_service

◆ durability_transient()

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

Definition at line 1109 of file Qos_Helper.h.

References DDS::TRANSIENT_DURABILITY_QOS.

1110  {
1112  return *this;
1113  }
DurabilityQosPolicyKind kind
DurabilityQosPolicy durability

◆ durability_transient_local()

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

Definition at line 1103 of file Qos_Helper.h.

References DDS::TRANSIENT_LOCAL_DURABILITY_QOS.

1104  {
1106  return *this;
1107  }
DurabilityQosPolicyKind kind
DurabilityQosPolicy durability

◆ durability_volatile()

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

Definition at line 1097 of file Qos_Helper.h.

References DDS::VOLATILE_DURABILITY_QOS.

1098  {
1100  return *this;
1101  }
DurabilityQosPolicyKind kind
DurabilityQosPolicy durability

◆ history_depth()

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

Definition at line 1273 of file Qos_Helper.h.

Referenced by durability_service_history_depth().

1274  {
1275  qos_.history.depth = depth;
1276  return *this;
1277  }
HistoryQosPolicy history

◆ history_keep_all()

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

Definition at line 1267 of file Qos_Helper.h.

References DDS::KEEP_ALL_HISTORY_QOS.

1268  {
1270  return *this;
1271  }
HistoryQosPolicyKind kind
HistoryQosPolicy history

◆ history_keep_last()

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

Definition at line 1260 of file Qos_Helper.h.

References DDS::KEEP_LAST_HISTORY_QOS.

1261  {
1263  qos_.history.depth = depth;
1264  return *this;
1265  }
HistoryQosPolicyKind kind
HistoryQosPolicy history

◆ history_kind()

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

Definition at line 1254 of file Qos_Helper.h.

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

1255  {
1256  qos_.history.kind = kind;
1257  return *this;
1258  }
HistoryQosPolicyKind kind
HistoryQosPolicy history

◆ latency_budget_duration()

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

Definition at line 1176 of file Qos_Helper.h.

1177  {
1178  qos_.latency_budget.duration = duration;
1179  return *this;
1180  }
LatencyBudgetQosPolicy latency_budget

◆ lifespan_duration()

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

Definition at line 1303 of file Qos_Helper.h.

1304  {
1305  qos_.lifespan.duration = duration;
1306  return *this;
1307  }
LifespanQosPolicy lifespan

◆ liveliness_automatic()

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

Definition at line 1188 of file Qos_Helper.h.

References DDS::AUTOMATIC_LIVELINESS_QOS.

1189  {
1191  return *this;
1192  }
LivelinessQosPolicy liveliness
LivelinessQosPolicyKind kind

◆ liveliness_kind()

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

Definition at line 1182 of file Qos_Helper.h.

1183  {
1184  qos_.liveliness.kind = kind;
1185  return *this;
1186  }
LivelinessQosPolicy liveliness
LivelinessQosPolicyKind kind

◆ liveliness_lease_duration()

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

Definition at line 1206 of file Qos_Helper.h.

1207  {
1208  qos_.liveliness.lease_duration = duration;
1209  return *this;
1210  }
LivelinessQosPolicy liveliness

◆ liveliness_manual_by_participant()

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

Definition at line 1194 of file Qos_Helper.h.

References DDS::MANUAL_BY_PARTICIPANT_LIVELINESS_QOS.

1195  {
1197  return *this;
1198  }
LivelinessQosPolicy liveliness
LivelinessQosPolicyKind kind

◆ liveliness_manual_by_topic()

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

Definition at line 1200 of file Qos_Helper.h.

References DDS::MANUAL_BY_TOPIC_LIVELINESS_QOS.

1201  {
1203  return *this;
1204  }
LivelinessQosPolicy liveliness
LivelinessQosPolicyKind kind

◆ operator const DDS::TopicQos &()

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

Definition at line 1082 of file Qos_Helper.h.

1082 { return qos_; }

◆ operator DDS::TopicQos &()

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

Definition at line 1083 of file Qos_Helper.h.

1083 { return qos_; }

◆ ownership_exclusive()

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

Definition at line 1321 of file Qos_Helper.h.

References DDS::EXCLUSIVE_OWNERSHIP_QOS.

1322  {
1324  return *this;
1325  }
OwnershipQosPolicy ownership
OwnershipQosPolicyKind kind

◆ ownership_kind()

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

Definition at line 1309 of file Qos_Helper.h.

1310  {
1311  qos_.ownership.kind = kind;
1312  return *this;
1313  }
OwnershipQosPolicy ownership
OwnershipQosPolicyKind kind

◆ ownership_shared()

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

Definition at line 1315 of file Qos_Helper.h.

References DDS::SHARED_OWNERSHIP_QOS.

1316  {
1318  return *this;
1319  }
OwnershipQosPolicy ownership
OwnershipQosPolicyKind kind

◆ qos() [1/2]

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

Definition at line 1080 of file Qos_Helper.h.

1080 { return qos_; }

◆ qos() [2/2]

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

Definition at line 1081 of file Qos_Helper.h.

1081 { return qos_; }

◆ reliability_best_effort()

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

Definition at line 1218 of file Qos_Helper.h.

References DDS::BEST_EFFORT_RELIABILITY_QOS.

1219  {
1221  return *this;
1222  }
ReliabilityQosPolicyKind kind
ReliabilityQosPolicy reliability

◆ reliability_kind()

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

Definition at line 1212 of file Qos_Helper.h.

1213  {
1214  qos_.reliability.kind = kind;
1215  return *this;
1216  }
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 1230 of file Qos_Helper.h.

1231  {
1232  qos_.reliability.max_blocking_time = duration;
1233  return *this;
1234  }
ReliabilityQosPolicy reliability

◆ reliability_reliable()

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

Definition at line 1224 of file Qos_Helper.h.

References DDS::RELIABLE_RELIABILITY_QOS.

1225  {
1227  return *this;
1228  }
ReliabilityQosPolicyKind kind
ReliabilityQosPolicy reliability

◆ resource_limits_max_instances()

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

Definition at line 1285 of file Qos_Helper.h.

References value.

1286  {
1288  return *this;
1289  }
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 1279 of file Qos_Helper.h.

References value.

1280  {
1282  return *this;
1283  }
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 1291 of file Qos_Helper.h.

References value.

1292  {
1294  return *this;
1295  }
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 1085 of file Qos_Helper.h.

References value.

1086  {
1088  return *this;
1089  }
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 1297 of file Qos_Helper.h.

References value.

1298  {
1300  return *this;
1301  }
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 1328 of file Qos_Helper.h.


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