Specialization of TopicDescription that allows for content-based subscriptions.
More...
#include <ContentFilteredTopic.hpp>
|
ContentFilteredTopicImpl * | impl_ |
|
std::string | name_ |
| Name that allows the TopicDescription to be retrieved locally.
|
|
std::string | type_name_ |
| Name that defines a unique resulting type for the publication or the subscription.
|
|
Specialization of TopicDescription that allows for content-based subscriptions.
◆ ~ContentFilteredTopic()
◆ get_expression_parameters()
FASTDDS_EXPORTED_API ReturnCode_t get_expression_parameters |
( |
std::vector< std::string > & |
expression_parameters | ) |
const |
Get the expression parameters.
This operation returns expression parameters associated with this ContentFilteredTopic. These will be the expression_parameters
specified on the last successful call to set_expression
or set_expression_parameters
. If those methods have never been called, the expression parameters specified when the ContentFilteredTopic was created will be returned.
- Parameters
-
[out] | expression_parameters | The expression parameters currently associated with the ContentFilteredTopic. |
- Returns
- RETCODE_OK
◆ get_filter_expression()
FASTDDS_EXPORTED_API const std::string & get_filter_expression |
( |
| ) |
const |
Get the filter expression.
This operation returns filter expression associated with this ContentFilteredTopic. It will return the filter_expression
specified on the last successful call to set_expression
or, if that method is never called, the expression specified when the ContentFilteredTopic was created.
- Returns
- the
filter_expression
.
◆ get_impl()
TopicDescriptionImpl * get_impl |
( |
| ) |
const |
|
overridevirtual |
◆ get_participant()
◆ get_related_topic()
FASTDDS_EXPORTED_API Topic * get_related_topic |
( |
| ) |
const |
◆ set_expression_parameters()
FASTDDS_EXPORTED_API ReturnCode_t set_expression_parameters |
( |
const std::vector< std::string > & |
expression_parameters | ) |
|
Set the expression parameters.
This operation changes expression parameters associated with this ContentFilteredTopic.
- Parameters
-
[in] | expression_parameters | The expression parameters to set. |
- Returns
- RETCODE_OK if the expression parameters where correctly updated.
-
RETCODE_BAD_PARAMETER if the expression parameters do not match with the current
filter_expression
.
◆ set_filter_expression()
FASTDDS_EXPORTED_API ReturnCode_t set_filter_expression |
( |
const std::string & |
filter_expression, |
|
|
const std::vector< std::string > & |
expression_parameters |
|
) |
| |
Set the filter expression and the expression parameters.
This operation changes the filter expression and the expression parameters associated with this ContentFilteredTopic.
- Parameters
-
[in] | filter_expression | The filter expression to set. |
[in] | expression_parameters | The expression parameters to set. |
- Returns
- RETCODE_OK if the expression and parameters where correctly updated.
-
RETCODE_BAD_PARAMETER if
filter_expression
is not valid for this ContentFilteredTopic.
-
RETCODE_BAD_PARAMETER if the expression parameters do not match with the
filter_expression
.
◆ DomainParticipantImpl
friend class DomainParticipantImpl |
|
friend |
◆ impl_
ContentFilteredTopicImpl* impl_ |
|
protected |
The documentation for this class was generated from the following file: