Click or drag to resize

ContentFilteredTopic Class

ContentFilteredTopic is an implementation of ITopicDescription that allows for content-based subscriptions. ContentFilteredTopic describes a more sophisticated subscription that indicates the subscriber does not want to necessarily see all values of each instance published under the Topic. Rather, it wants to see only the values whose contents satisfy certain criteria. This class therefore can be used to request content-based subscriptions.
Inheritance Hierarchy

Namespace:  OpenDDSharp.DDS
Assembly:  OpenDDSharp (in OpenDDSharp.dll) Version: 0.4.1.0
Syntax
public class ContentFilteredTopic : TopicDescription

The ContentFilteredTopic type exposes the following members.

Properties
  NameDescription
Public propertyFilterExpression
Gets the filter expression associated with the ContentFilteredTopic. That is, the expression specified when the ContentFilteredTopic was created.
Public propertyName
Gets the name used to create the ITopicDescription.
(Inherited from TopicDescription.)
Public propertyParticipant
Gets the DomainParticipant to which the ITopicDescription belongs.
(Inherited from TopicDescription.)
Public propertyRelatedTopic
Gets the Topic associated with the ContentFilteredTopic. That is, the Topic specified when the ContentFilteredTopic was created.
Public propertyTypeName
Gets type name used to create the ITopicDescription.
(Inherited from TopicDescription.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetExpressionParameters
Gets the expression parameters associated with the ContentFilteredTopic. That is, the parameters specified on the last successful call to SetExpressionParameters(String), or if it was never called, the parameters specified when the ContentFilteredTopic was created.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSetExpressionParameters
Changes the expression parameters associated with the ContentFilteredTopic.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
The selection of the content is done using the filter expression with the expression parameters.
  • The filter expression is a string that specifies the criteria to select the data samples of interest. It is similar to the WHERE part of an SQL clause.
  • The expression parameters are a collection of strings that give values to the 'parameters' ("%n" tokens) in the filter expression. The number of supplied parameters must fit with the requested values in the filter expression
See Also