DDS::MultiTopic Class Reference
[Topics]

[Not supported (optional)] <<interface>> A specialization of DDS::TopicDescription that allows subscriptions that combine/filter/rearrange data coming from several topics. More...

#include <managed_topic.h>

Inheritance diagram for DDS::MultiTopic:

DDS::ITopicDescription

List of all members.

Public Member Functions

System::String^ get_subscription_expression ()
 Get the expression for this DDS::MultiTopic.
void get_expression_parameters (StringSeq^ parameters)
 Get the expression parameters.
void set_expression_parameters (StringSeq^ parameters)
 Set the expression_parameters.
virtual System::String^ get_type_name ()
 Get the associated type_name.
virtual System::String^ get_name ()
 Get the name used to create this DDS::TopicDescription .
virtual DomainParticipantget_participant ()
 Get the DDS::DomainParticipant to which the DDS::TopicDescription belongs.

Static Public Member Functions

static MultiTopicnarrow (ITopicDescription^ topic_description)
 Narrow the given DDS::TopicDescription pointer to a DDS::MultiTopic pointer.


Detailed Description

[Not supported (optional)] <<interface>> A specialization of DDS::TopicDescription that allows subscriptions that combine/filter/rearrange data coming from several topics.

DDS::MultiTopic allows a more sophisticated subscription that can select and combine data received from multiple topics into a single resulting type (specified by the inherited type_name). The data will then be filtered (selection) and possibly re-arranged (aggregation/projection) according to a subscription_expression with parameters expression_parameters.

Note that the source for data may not be restricted to a single topic.

DDS::DataReader entities associated with a DDS::MultiTopic may access instances that are "constructed" at the DDS::DataReader side from the instances written by multiple DDS::DataWriter entities. The DDS::MultiTopic access instance will begin to exist as soon as all the constituting DDS::Topic instances are in existence. The view_state and instance_state is computed from the corresponding states of the constituting instances:

Queries and Filters Syntax describes the syntax of subscription_expression and expression_parameters.

Member Function Documentation

static MultiTopic ^ DDS::MultiTopic::narrow ( ITopicDescription^   topic_description  )  [inline, static]

Narrow the given DDS::TopicDescription pointer to a DDS::MultiTopic pointer.

Returns:
DDS::MultiTopic if this DDS::TopicDescription is a DDS::MultiTopic. Otherwise, return NULL.

System::String ^ DDS::MultiTopic::get_subscription_expression (  )  [inline]

Get the expression for this DDS::MultiTopic.

The expressions syntax is described in the DDS specification. It is specified when the DDS::MultiTopic is created.

Returns:
subscription_expression of the DDS::MultiTopic.

void DDS::MultiTopic::get_expression_parameters ( StringSeq^   parameters  )  [inline]

Get the expression parameters.

The expressions syntax is described in the DDS specification.

The parameters is either specified on the last successful call to DDS::MultiTopic::set_expression_parameters, or if DDS::MultiTopic::set_expression_parameters was never called, the parameters specified when the DDS::MultiTopic was created.

Parameters:
parameters <<inout>> Fill in this sequence with the expression parameters. Cannot be NULL.
Exceptions:
One of the Standard Return Codes

void DDS::MultiTopic::set_expression_parameters ( StringSeq^   parameters  )  [inline]

Set the expression_parameters.

Changes the expression_parameters associated with the DDS::MultiTopic.

Parameters:
parameters <<in>> the filter expression parameters
Returns:
One of the Standard Return Codes.

virtual System::String ^ DDS::MultiTopic::get_type_name (  )  [inline, virtual]

Get the associated type_name.

The type name defines a locally unique type for the publication or the subscription.

The type_name corresponds to a unique string used to register a type via the FooTypeSupport::register_type method.

Thus, the type_name implies an association with a corresponding DDS::TypeSupport and this DDS::TopicDescription.

Returns:
the type name. The returned type name is valid until the DDS::TopicDescription is deleted.
Postcondition:
The result is non-NULL.
See also:
DDS::TypeSupport, FooTypeSupport

Implements DDS::ITopicDescription.

virtual System::String ^ DDS::MultiTopic::get_name (  )  [inline, virtual]

Get the name used to create this DDS::TopicDescription .

Returns:
the name used to create this DDS::TopicDescription. The returned topic name is valid until the DDS::TopicDescription is deleted.
Postcondition:
The result is non-NULL.

Implements DDS::ITopicDescription.

virtual DomainParticipant ^ DDS::MultiTopic::get_participant (  )  [inline, virtual]

Get the DDS::DomainParticipant to which the DDS::TopicDescription belongs.

Returns:
The DDS::DomainParticipant to which the DDS::TopicDescription belongs.
Postcondition:
The result is non-NULL.

Implements DDS::ITopicDescription.


RTI Data Distribution Service .Net APIs Version 4.5c Copyright © 9 Jun 2010 Real-Time Innovations, Inc