RTI Connext Modern C++ API Version 7.3.0
rti::topic Namespace Reference

<<extension>> Extensions to dds::topic More...

Classes

class  ContentFilter
 <<extension>> A class to inherit from when implementing a custom content filter More...
 
class  CustomFilter
 <<extension>> <<reference-type>> A wrapper class for the user-defined implementation of a ContentFilter. More...
 
struct  dynamic_type
 Provides a DynamicType that represents an IDL-generated type. More...
 
class  ExpressionProperty
 <<extension>> <<value-type>> Provides additional information about the filter expression passed to the writer_compile method of rti::topic::WriterContentFilter More...
 
struct  extensibility
 <<extension>> Indicates the extensibility kind of a topic-type More...
 
class  FilterSampleInfo
 <<extension>> <<value-type>> Provides meta information associated with the sample. More...
 
struct  no_compile_data_t
 The type to specify as the CompileData template parameter to your ContentFilter if your compile function does not return any data. More...
 
struct  PrintFormatKind_def
 The definition of the dds::core::safe_enum PrintFormatKind. More...
 
class  PrintFormatProperty
 <<extension>> <<value-type>> A collection of attributes used to configure how data samples will be formatted when converted to a string. More...
 
class  ServiceRequest
 <<extension>> <<value-type>> A request coming from one of the built-in services More...
 
struct  topic_type_disabled_copy
 <<extension>> Indicates whether a TopicType is uncopyable More...
 
struct  topic_type_has_external_members
 <<extension>> Indicates if a topic type contains directly or indirectly IDL external members. More...
 
class  WriterContentFilter
 <<extension>> A class to inherit from when implementing a writer-side custom content filter More...
 
class  WriterContentFilterHelper
 <<extension>> A class to inherit from when implementing a writer-side custom content filter. More...
 

Typedefs

typedef dds::core::safe_enum< PrintFormatKind_defPrintFormatKind
 Safe Enumeration of PrintFormatKind_def Format kinds available when converting data samples to string representations. More...
 

Functions

template<typename TopicType >
void from_cdr_buffer_no_alloc (TopicType &sample, const std::vector< char > &buffer)
 Deserializes a sample from a buffer of bytes in CDR format. More...
 
template<typename TopicType >
TopicType from_cdr_buffer (const std::vector< char > &buffer)
 Creates a sample by deserializing a buffer of bytes in CDR format. More...
 
template<typename TopicType >
std::vector< char > & to_cdr_buffer (std::vector< char > &buffer, const TopicType &sample, dds::core::policy::DataRepresentationId representation)
 Serializes a sample into a buffer of octets in CDR format. More...
 
template<typename TopicType >
std::vector< char > & to_cdr_buffer (std::vector< char > &buffer, const TopicType &sample)
 Serializes a sample into a buffer of octets in CDR format. More...
 
std::string sql_filter_name ()
 <<extension>> The name of the built-in SQL filter More...
 
std::string stringmatch_filter_name ()
 <<extension>> The name of the built-in StringMatch filter More...
 
template<typename AnyTopicBackInsertIterator >
uint32_t find_topics (dds::domain::DomainParticipant participant, AnyTopicBackInsertIterator begin)
 <<extension>> Retrieve all the dds::topic::Topic created from this dds::domain::DomainParticipant More...
 
template<typename AnyTopicForwardIterator >
uint32_t find_topics (dds::domain::DomainParticipant participant, AnyTopicForwardIterator begin, uint32_t max_size)
 <<extension>> Retrieve all the dds::topic::Topic created from this dds::domain::DomainParticipant More...
 
template<typename T >
CustomFilter< T > find_content_filter (const dds::domain::DomainParticipant &participant, const std::string &filter_name)
 Lookup a content filter previously registered with dds::domain::DomainParticipant::register_contentfilter. More...
 
template<typename FwdIterator >
uint32_t find_registered_content_filters (const dds::domain::DomainParticipant &participant, FwdIterator begin, uint32_t max_size)
 <<extension>> Lookup the names of up to max_size number of the custom content filters registered to a dds::domain::DomainParticipant More...
 
template<typename BinIterator >
uint32_t find_registered_content_filters (const dds::domain::DomainParticipant &participant, BinIterator begin)
 Lookup the names of all of the custom content filters registered to a dds::domain::DomainParticipant. More...
 
template<typename TopicType >
std::ostream & to_string (std::ostream &out, const TopicType &sample, const PrintFormatProperty &print_format=PrintFormatProperty::Default())
 Prints a data sample to an output stream. More...
 
template<typename TopicType >
std::string to_string (const TopicType &sample, const PrintFormatProperty &print_format=PrintFormatProperty::Default())
 Tranforms a data sample into a human-readable string format. More...
 
template<typename TopicType >
TopicType from_string (RTI_STRING_IN str, PrintFormatKind format_kind=PrintFormatKind::JSON)
 Creates a data sample from a JSON string representation. More...
 
std::string service_request_topic_name ()
 ServiceRequest built-in topic name. More...
 

Detailed Description

<<extension>> Extensions to dds::topic

Function Documentation

◆ find_topics() [1/2]

template<typename AnyTopicBackInsertIterator >
uint32_t rti::topic::find_topics ( dds::domain::DomainParticipant  participant,
AnyTopicBackInsertIterator  begin 
)

<<extension>> Retrieve all the dds::topic::Topic created from this dds::domain::DomainParticipant

#include <dds/topic/find.hpp>

Note
This is a standalone function in the namespace rti::topic
Template Parameters
AnyTopicBackInsertIteratorType of the back-inserting iterator, whose value_type is dds::topic::AnyTopic.
Parameters
participantThe dds::domain::DomainParticipant the Topics belong to
beginA back-inserting iterator to the position in the destination container to insert the found Topics into
Returns
The number of found Topics

◆ find_topics() [2/2]

template<typename AnyTopicForwardIterator >
uint32_t rti::topic::find_topics ( dds::domain::DomainParticipant  participant,
AnyTopicForwardIterator  begin,
uint32_t  max_size 
)

<<extension>> Retrieve all the dds::topic::Topic created from this dds::domain::DomainParticipant

#include <dds/topic/find.hpp>

Note
This is a standalone function in the namespace rti::topic
Template Parameters
AnyTopicBackInsertIteratorType of the back-inserting iterator, whose value_type is dds::topic::AnyTopic.
Parameters
participantThe dds::domain::DomainParticipant the Topics belong to
beginA forward iterator to the position in the destination container to insert the found Topics in
max_sizeThe maximum number of Topics to return
Returns
The number of found Topics

◆ find_registered_content_filters() [1/2]

template<typename FwdIterator >
uint32_t rti::topic::find_registered_content_filters ( const dds::domain::DomainParticipant participant,
FwdIterator  begin,
uint32_t  max_size 
)

<<extension>> Lookup the names of up to max_size number of the custom content filters registered to a dds::domain::DomainParticipant

Note
This is a standalone function in the namespace rti::topic

The names of the RTI Connext built-in content filters will not be returned as part of the list.

Template Parameters
FwdIteratorA forwward iterator whose value type is std::string (or convertible to)
Parameters
participantThe dds::domain::DomainParticipant that the content filters are registered with
beginA forward iterator to the position in the destination container to insert the names of the found content filters into
max_sizeThe maximum number of filters to lookup
Returns
The number of found content filters

Referenced by dds::topic::ContentFilteredTopic< T >::find_registered_content_filters().

◆ find_registered_content_filters() [2/2]

template<typename BinIterator >
uint32_t rti::topic::find_registered_content_filters ( const dds::domain::DomainParticipant participant,
BinIterator  begin 
)

Lookup the names of all of the custom content filters registered to a dds::domain::DomainParticipant.

#include <dds/topic/find.hpp>

Note
This is a standalone function in the namespace rti::topic

The names of the RTI Connext built-in content filters will not be returned as part of the list.

Template Parameters
BinIteratorA back-inserting iterator whose value type is std::string (or convertible to)
Parameters
participantThe dds::domain::DomainParticipant that the content filters are registered with
beginA back-inserting iterator to the position in the destination container to insert the the names of the found content filters into
Returns
The number of found content filters