|
DomainParticipantCreateContentFilteredTopic Method
|
Namespace:
OpenDDSharp.DDS
Assembly:
OpenDDSharp (in OpenDDSharp.dll) Version: 0.5.0.0
Syntax public ContentFilteredTopic CreateContentFilteredTopic(
string name,
Topic relatedTopic,
string filterExpression,
params string[] expressionParameters
)
Public Function CreateContentFilteredTopic (
name As String,
relatedTopic As Topic,
filterExpression As String,
ParamArray expressionParameters As String()
) As ContentFilteredTopic
public:
ContentFilteredTopic^ CreateContentFilteredTopic(
String^ name,
Topic^ relatedTopic,
String^ filterExpression,
... array<String^>^ expressionParameters
)
member CreateContentFilteredTopic :
name : string *
relatedTopic : Topic *
filterExpression : string *
expressionParameters : string[] -> ContentFilteredTopic
Parameters
- name
- Type: SystemString
The name of the ContentFilteredTopic. - relatedTopic
- Type: OpenDDSharp.DDSTopic
The related Topic. - filterExpression
- Type: SystemString
The filter expression to be used for the content filter. - expressionParameters
- Type: SystemString
The collection of parameters to be used in the filter expression.
Return Value
Type:
ContentFilteredTopicThe newly created
ContentFilteredTopic on success, otherwise
.
Remarks
The related
Topic being subscribed to is specified by means of the
relatedTopic parameter. The
ContentFilteredTopic only
relates to samples published under that
Topic, filtered according to their content. The filtering is done by means of evaluating a
logical expression that involves the values of some of the data-fields in the sample. The logical expression is derived from the
filterExpression and
expressionParameters arguments.
See Also