Inheritance diagram for org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >:

Collaboration diagram for org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >:

Public Member Functions
	ContentFilteredTopicImpl (OsplServiceEnvironment environment, DomainParticipantImpl parent, String name, AbstractTopic< TYPE > relatedTopic, String filterExpression, List< String > expressionParameters)

void	close ()
	Dispose the resources held by this object. More...

ServiceEnvironment	getEnvironment ()

List< String >	getExpressionParameters ()
	This operation returns the expression parameters associated with the ContentFilteredTopic, that is, the parameters specified on the last successful call to setExpressionParameters(List), or if setExpressionParameters(List) was never called, the parameters specified when the ContentFilteredTopic was created. More...

String	getFilterExpression ()
	The filter expression associated with the ContentFilteredTopic, that is, the expression specified when the ContentFilteredTopic was created. More...

String	getName ()
	Returns the name used to create the TopicDescription. More...

DDS.TopicDescription	getOld ()

DomainParticipant	getParent ()
	Returns the org.omg.dds.domain.DomainParticipant to which the TopicDescription belongs. More...

Topic<? extends TYPE >	getRelatedTopic ()
	The org.omg.dds.topic.Topic associated with the ContentFilteredTopic, that is, the Topic specified when the ContentFilteredTopic was created. More...

String	getTypeName ()
	Returns the type name used to create the TopicDescription. More...

TypeSupport< TYPE >	getTypeSupport ()
	Returns the org.omg.dds.type.TypeSupport used to create this TopicDescription. More...

void	retain ()

void	setExpressionParameters (List< String > expressionParameters)
	This operation changes the expression parameters associated with the ContentFilteredTopic. More...

void	setExpressionParameters (String... expressionParameters)
	This operation changes the expression parameters associated with the ContentFilteredTopic. More...

Detailed Description

Definition at line 40 of file ContentFilteredTopicImpl.java.

Constructor & Destructor Documentation

◆ ContentFilteredTopicImpl()

org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.ContentFilteredTopicImpl	(	OsplServiceEnvironment	environment,
		DomainParticipantImpl	parent,
		String	name,
		AbstractTopic< TYPE >	relatedTopic,
		String	filterExpression,
		List< String >	expressionParameters
	)

Definition at line 48 of file ContentFilteredTopicImpl.java.

Member Function Documentation

◆ close()

void org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.close ( )

Dispose the resources held by this object.

A TopicDescription cannot be closed if it is in use by any org.omg.dds.pub.DataWriters or org.omg.dds.sub.DataReaders. With respect to org.omg.dds.topic.Topics specifically: a Topic cannot be closed if it has any remaining org.omg.dds.topic.ContentFilteredTopics or org.omg.dds.topic.MultiTopics related to it.

See also: org.omg.dds.core.Entity::close()

Implements org.opensplice.dds.topic.TopicDescriptionExt< TYPE >.

Definition at line 110 of file ContentFilteredTopicImpl.java.

◆ getEnvironment()

ServiceEnvironment org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.getEnvironment ( )

Returns: the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implements org.omg.dds.core.DDSObject.

Definition at line 122 of file ContentFilteredTopicImpl.java.

◆ getExpressionParameters()

List<String> org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.getExpressionParameters ( )

This operation returns the expression parameters associated with the ContentFilteredTopic, that is, the parameters specified on the last successful call to setExpressionParameters(List), or if setExpressionParameters(List) was never called, the parameters specified when the ContentFilteredTopic was created.

Returns: an unmodifiable list.

See also: #setExpressionParameters(List)

Implements org.omg.dds.topic.ContentFilteredTopic< TYPE >.

Definition at line 137 of file ContentFilteredTopicImpl.java.

◆ getFilterExpression()

String org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.getFilterExpression ( )

The filter expression associated with the ContentFilteredTopic, that is, the expression specified when the ContentFilteredTopic was created.

Returns: the filter expression

Implements org.omg.dds.topic.ContentFilteredTopic< TYPE >.

Definition at line 132 of file ContentFilteredTopicImpl.java.

◆ getName()

String org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.getName ( )

Returns the name used to create the TopicDescription.

Returns: the name.

Implements org.omg.dds.topic.TopicDescription< TYPE >.

Definition at line 100 of file ContentFilteredTopicImpl.java.

◆ getOld()

DDS.TopicDescription org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.getOld ( )

Implements org.opensplice.dds.topic.TopicDescriptionExt< TYPE >.

Definition at line 127 of file ContentFilteredTopicImpl.java.

◆ getParent()

DomainParticipant org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.getParent ( )

Returns the org.omg.dds.domain.DomainParticipant to which the TopicDescription belongs.

Returns: the org.omg.dds.domain.DomainParticipant

Implements org.omg.dds.topic.TopicDescription< TYPE >.

Definition at line 105 of file ContentFilteredTopicImpl.java.

◆ getRelatedTopic()

Topic<? extends TYPE> org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.getRelatedTopic ( )

The org.omg.dds.topic.Topic associated with the ContentFilteredTopic, that is, the Topic specified when the ContentFilteredTopic was created.

Returns: the org.omg.dds.topic.Topic associated with the ContentFilteredTopic

Implements org.omg.dds.topic.ContentFilteredTopic< TYPE >.

Definition at line 157 of file ContentFilteredTopicImpl.java.

◆ getTypeName()

String org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.getTypeName ( )

Returns the type name used to create the TopicDescription.

Returns: the type name

Implements org.omg.dds.topic.TopicDescription< TYPE >.

Definition at line 95 of file ContentFilteredTopicImpl.java.

◆ getTypeSupport()

TypeSupport<TYPE> org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.getTypeSupport ( )

Returns the org.omg.dds.type.TypeSupport used to create this TopicDescription.

Returns: the org.omg.dds.type.TypeSupport.

Implements org.omg.dds.topic.TopicDescription< TYPE >.

Definition at line 76 of file ContentFilteredTopicImpl.java.

◆ retain()

void org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.retain ( )

Implements org.opensplice.dds.topic.TopicDescriptionExt< TYPE >.

Definition at line 171 of file ContentFilteredTopicImpl.java.

◆ setExpressionParameters() [1/2]

void org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.setExpressionParameters ( List< String > expressionParameters )

This operation changes the expression parameters associated with the ContentFilteredTopic.

Parameters

expressionParameters The expressionParameters attribute is a collection of strings that give values to the "parameters" (i.e., "%n" tokens) in the queryExpression. The number of supplied parameters must fit with the requested values in the queryExpression (i.e., the number of "%n" tokens).

See also: getExpressionParameters()

Implements org.omg.dds.topic.ContentFilteredTopic< TYPE >.

Definition at line 146 of file ContentFilteredTopicImpl.java.

◆ setExpressionParameters() [2/2]

void org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.setExpressionParameters ( String... expressionParameters )

This operation changes the expression parameters associated with the ContentFilteredTopic.

Parameters

expressionParameters The expressionParameters attribute is a sequence of strings that give values to the "parameters" (i.e., "%n" tokens) in the queryExpression. The number of supplied parameters must fit with the requested values in the queryExpression (i.e., the number of "%n" tokens).

See also: getExpressionParameters() NOTE: This operation is not yet implemented. It is scheduled for a future release.

Implements org.omg.dds.topic.ContentFilteredTopic< TYPE >.

Definition at line 162 of file ContentFilteredTopicImpl.java.

The documentation for this class was generated from the following file:

java5/common/java/code/org/opensplice/dds/topic/ContentFilteredTopicImpl.java

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ContentFilteredTopicImpl()

Member Function Documentation

◆ close()

◆ getEnvironment()

◆ getExpressionParameters()

◆ getFilterExpression()

◆ getName()

◆ getOld()

◆ getParent()

◆ getRelatedTopic()

◆ getTypeName()

◆ getTypeSupport()

◆ retain()

◆ setExpressionParameters() [1/2]

◆ setExpressionParameters() [2/2]