DDS::rpc::ClientParams Class Reference

Used to pass configuration parameters when constructing a Client. More...

Public Member Functions
	ClientParams ()
	Default constructor.
	ClientParams (const ClientParams &other)
	Copy constructor.
ClientParams &	operator= (const ClientParams &that)
	Assignment operator.
ClientParams &	service_name (const std::string &service_name)
	Assign the service_name configured in this instance of ClientParams.
ClientParams &	instance_name (const std::string &instance_name)
	Assign the instance_name configured in this instance of ClientParams.
ClientParams &	request_topic_name (const std::string &req_topic)
	Assign the request_topic_name configured in this instance of ClientParams.
ClientParams &	reply_topic_name (const std::string &rep_topic)
	Assign the reply_topic_name configured in this instance of ClientParams.
ClientParams &	datawriter_qos (const dds_entity_traits::DataWriterQos &qos)
	Assign the DataWriterQos configured in this instance of ClientParams.
ClientParams &	datareader_qos (const dds_entity_traits::DataReaderQos &qos)
	Assign the DataReaderQos configured in this instance of ClientParams.
ClientParams &	publisher (dds_entity_traits::Publisher publisher)
	Assign the Publisher configured in this instance of ClientParams.
ClientParams &	subscriber (dds_entity_traits::Subscriber subscriber)
	Assign the Subscriber configured in this instance of ClientParams.
ClientParams &	domain_participant (dds_entity_traits::DomainParticipant part)
	Assign the DomainParticipant configured in this instance of ClientParams.
const std::string	service_name () const
	Access the service_name configured in this instance of ClientParams.
const std::string	instance_name () const
	Access the instance_name configured in this instance of ClientParams.
const std::string	request_topic_name () const
	Access the request_topic_name configured in this instance of ClientParams.
const std::string	reply_topic_name () const
	Access the reply_topic_name configured in this instance of ClientParams.
const dds_entity_traits::DataWriterQos	datawriter_qos () const
	Access the DataWriterQos configured in this instance of ClientParams.
const dds_entity_traits::DataReaderQos	datareader_qos () const
	Access the DataReaderQos configured in this instance of ClientParams.
dds_entity_traits::Publisher	publisher () const
	Access the Publisher configured in this instance of ClientParams.
dds_entity_traits::Subscriber	subscriber () const
	Access the Subscriber configured in this instance of ClientParams.
dds_entity_traits::DomainParticipant	domain_participant () const
	Access the DomainParticipant configured in this instance of ClientParams.

Detailed Description

Used to pass configuration parameters when constructing a Client.

ClientParams is a valuetype that serves as a container of configuration parameters of a Client. It is designed to mimic the named-parameters feature available in some programming languages, which improves readability.