RTI Connext Modern C++ API  Version 6.1.0
dds::domain::qos Namespace Reference

Contains DomainParticipantQos. More...

Classes

class  DomainParticipantFactoryQos
 <<value-type>> Container of the QoS policies that do not apply to a specific entity More...
 
class  DomainParticipantQos
 <<value-type>> Container of the QoS policies that a dds::domain::DomainParticipant supports More...
 

Functions

std::string to_string (const DomainParticipantFactoryQos &qos, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat())
 <<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantFactoryQos More...
 
std::string to_string (const DomainParticipantFactoryQos &qos, const DomainParticipantFactoryQos &base, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat())
 <<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantFactoryQos More...
 
std::string to_string (const DomainParticipantFactoryQos &qos, const rti::core::qos_print_all_t &qos_print_all, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat())
 <<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantFactoryQos More...
 
std::ostream & operator<< (std::ostream &out, const rti::domain::qos::DomainParticipantFactoryQos &qos)
 <<extension>> Prints a dds::sub::qos::DomainParticipantFactoryQos to an output stream. More...
 
std::string to_string (const DomainParticipantQos &qos, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat())
 <<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos More...
 
std::string to_string (const DomainParticipantQos &qos, const DomainParticipantQos &base, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat())
 <<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos More...
 
std::string to_string (const DomainParticipantQos &qos, const rti::core::qos_print_all_t &qos_print_all, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat())
 <<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos More...
 
std::ostream & operator<< (std::ostream &out, const rti::domain::qos::DomainParticipantQos &qos)
 <<extension>> Prints a dds::sub::qos::DomainParticipantQos to an output stream. More...
 

Detailed Description

Function Documentation

◆ to_string() [1/6]

std::string to_string ( const DomainParticipantFactoryQos qos,
const rti::core::QosPrintFormat format = rti::core::QosPrintFormat() 
)

<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantFactoryQos

Parameters
qosThe qos object to convert to a string
formatThe optional print format used to format the output string.

The several to_string overloads allow formatting the output and printing only the differences with respect to another Qos object.

DomainParticipantFactoryQos qos;
// When no QosPrintFormat is supplied, the default is used. Similarly, since
// no base profile has been specified we will only print the differences
// with respect to the documented default for DomainParticipantFactoryQos
// In this overload we are specifying the print format used to format the output
// string.
QosPrintFormat format; // ...;
str = to_string(qos, format);
// Here, the differences between qos and base will be included in the output
// string. If the two qos objects are the same, the resulting string will
// be empty.
DomainParticipantFactoryQos base; // ...;
str = to_string(qos, base);
// We could also specify the format at this point
str = to_string(qos, base, format);
// Instead of supplying a base profile, the sentinel value qos_print_all can
// be supplied. This will result in the entire Qos object being printed (as
// opposed to only the differences with respect to a base qos).

This overload uses the default print format and only prints the differences between qos and the documented default.

Returns
The string representation of the qos

◆ to_string() [2/6]

std::string to_string ( const DomainParticipantFactoryQos qos,
const DomainParticipantFactoryQos base,
const rti::core::QosPrintFormat format = rti::core::QosPrintFormat() 
)

<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantFactoryQos

Parameters
qosThe qos object to convert to a string
baseThe base qos. Only the differences between base and qos are included in the output string. If you want to print everything within the QoS, use the overload that accepts a rti::core::qos_print_all_t.
formatThe optional print format used to format the output string.

This overload prints the differences between qos and base. If no print format is specified, the default will be used.

Returns
The string representation of the qos

◆ to_string() [3/6]

std::string to_string ( const DomainParticipantFactoryQos qos,
const rti::core::qos_print_all_t qos_print_all,
const rti::core::QosPrintFormat format = rti::core::QosPrintFormat() 
)

<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantFactoryQos

Parameters
qosThe qos object to convert to a string
qos_print_allThe sentinel value indicating that the entire QoS should be converted to a string. The other overloads of this API only print the differences with respect to a base profile, or to the documented default.
formatThe optional print format used to format the output string.

This overload prints all of the policies within qos. If no print format is specified, the default will be used.

The only valid value for the qos_print_all argument is rti::core::qos_print_all

For example:

Returns
The string representation of the qos

◆ operator<<() [1/2]

std::ostream & operator<< ( std::ostream &  out,
const rti::domain::qos::DomainParticipantFactoryQos &  qos 
)
inline

<<extension>> Prints a dds::sub::qos::DomainParticipantFactoryQos to an output stream.

◆ to_string() [4/6]

std::string to_string ( const DomainParticipantQos qos,
const rti::core::QosPrintFormat format = rti::core::QosPrintFormat() 
)

<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos

Parameters
qosThe qos object to convert to a string
formatThe optional print format used to format the output string.

The several to_string overloads allow formatting the output and printing only the differences with respect to another Qos object.

DomainParticipantQos qos;
// When no QosPrintFormat is supplied, the default is used. Similarly, since
// no base profile has been specified we will only print the differences
// with respect to the documented default for DomainParticipantQos
// In this overload we are specifying the print format used to format the output
// string.
QosPrintFormat format; // ...;
str = to_string(qos, format);
// Here, the differences between qos and base will be included in the output
// string. If the two qos objects are the same, the resulting string will
// be empty.
DomainParticipantQos base; // ...;
str = to_string(qos, base);
// We could also specify the format at this point
str = to_string(qos, base, format);
// Instead of supplying a base profile, the sentinel value qos_print_all can
// be supplied. This will result in the entire Qos object being printed (as
// opposed to only the differences with respect to a base qos).

This overload uses the default print format and only prints the differences between qos and the documented default.

Returns
The string representation of the qos

◆ to_string() [5/6]

std::string to_string ( const DomainParticipantQos qos,
const DomainParticipantQos base,
const rti::core::QosPrintFormat format = rti::core::QosPrintFormat() 
)

<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos

Parameters
qosThe qos object to convert to a string
baseThe base qos. Only the differences between base and qos are included in the output string. If you want to print everything within the QoS, use the overload that accepts a rti::core::qos_print_all_t.
formatThe optional print format used to format the output string.

This overload prints the differences between qos and base. If no print format is specified, the default will be used.

Returns
The string representation of the qos

◆ to_string() [6/6]

std::string to_string ( const DomainParticipantQos qos,
const rti::core::qos_print_all_t qos_print_all,
const rti::core::QosPrintFormat format = rti::core::QosPrintFormat() 
)

<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos

Parameters
qosThe qos object to convert to a string
qos_print_allThe sentinel value indicating that the entire QoS should be converted to a string. The other overloads of this API only print the differences with respect to a base profile, or to the documented default.
formatThe optional print format used to format the output string.

This overload prints all of the policies within qos. If no print format is specified, the default will be used.

The only valid value for the qos_print_all argument is rti::core::qos_print_all

For example:

Returns
The string representation of the qos

◆ operator<<() [2/2]

std::ostream & operator<< ( std::ostream &  out,
const rti::domain::qos::DomainParticipantQos &  qos 
)
inline

<<extension>> Prints a dds::sub::qos::DomainParticipantQos to an output stream.