RTI Connext C# API Version 7.2.0
Rti.Dds.Topics.AnyContentFilteredTopic Class Reference

The abstract base of a typed ContentFilteredTopic<T>. Provides type-independent methods and properties. More...

Inheritance diagram for Rti.Dds.Topics.AnyContentFilteredTopic:
Rti.Dds.Topics.ITopicDescription Rti.Dds.Topics.ContentFilteredTopic< T >

Public Member Functions

void AppendToExpressionParameter (int index, string value)
 Appends a string term to the specified parameter string. More...
 
void RemoveFromExpressionParameter (int index, string value)
 Removes a string term from the specified parameter string. More...
 
void Dispose ()
 Destroys this object and the resources it uses. More...
 

Properties

string Name [get]
 Name used to create the content-filtered topic More...
 
string TypeName [get]
 Name of the data type associated with this content-filtered topic More...
 
DomainParticipant DomainParticipant [get]
 The DomainParticipant that contains this content-filtered topic More...
 
string FilterExpression [get]
 The filter expression More...
 
IEnumerable< string > FilterParameters [get, set]
 The filter parameters when the expression is parameterized. More...
 
Filter Filter [get, set]
 The Filter object contains both the expression and the parameters, as well as the filter class name, if applicable. More...
 
bool Disposed [get]
 Whether the Dispose method has been called. More...
 
- Properties inherited from Rti.Dds.Topics.ITopicDescription
DomainParticipant DomainParticipant [get]
 The DomainParticipant that created this topic More...
 
string Name [get]
 The name given to this topic More...
 
string TypeName [get]
 The name of the type associated with this topic. More...
 

Detailed Description

The abstract base of a typed ContentFilteredTopic<T>. Provides type-independent methods and properties.

Member Function Documentation

◆ AppendToExpressionParameter()

void Rti.Dds.Topics.AnyContentFilteredTopic.AppendToExpressionParameter ( int  index,
string  value 
)

Appends a string term to the specified parameter string.

The full documentation is available in the C API: DDS_ContentFilteredTopic_append_to_expression_parameter

◆ RemoveFromExpressionParameter()

void Rti.Dds.Topics.AnyContentFilteredTopic.RemoveFromExpressionParameter ( int  index,
string  value 
)

Removes a string term from the specified parameter string.

The full documentation is available in the C API: DDS_ContentFilteredTopic_remove_from_expression_parameter

◆ Dispose()

void Rti.Dds.Topics.AnyContentFilteredTopic.Dispose ( )
inline

Destroys this object and the resources it uses.

Property Documentation

◆ Name

string Rti.Dds.Topics.AnyContentFilteredTopic.Name
get

Name used to create the content-filtered topic

Implements Rti.Dds.Topics.ITopicDescription.

◆ TypeName

string Rti.Dds.Topics.AnyContentFilteredTopic.TypeName
get

Name of the data type associated with this content-filtered topic

Implements Rti.Dds.Topics.ITopicDescription.

◆ DomainParticipant

DomainParticipant Rti.Dds.Topics.AnyContentFilteredTopic.DomainParticipant
get

The DomainParticipant that contains this content-filtered topic

Implements Rti.Dds.Topics.ITopicDescription.

◆ FilterExpression

string Rti.Dds.Topics.AnyContentFilteredTopic.FilterExpression
get

The filter expression

◆ FilterParameters

IEnumerable<string> Rti.Dds.Topics.AnyContentFilteredTopic.FilterParameters
getset

The filter parameters when the expression is parameterized.

The parameters can be modified to change what data readers associated to this topic will receive.

◆ Filter

Filter Rti.Dds.Topics.AnyContentFilteredTopic.Filter
getset

The Filter object contains both the expression and the parameters, as well as the filter class name, if applicable.

The filter can be modified to change what data readers associated to this topic will receive.

◆ Disposed

bool Rti.Dds.Topics.AnyContentFilteredTopic.Disposed
get

Whether the Dispose method has been called.