lac.cnet.sddl.udi.core

Interface DDSStandardAPI<GenericTopic,GenericTopicTypeSupport,GenericContentFilteredTopic,GenericDomainParticipantQos,GenericSubscriberQos,GenericDomainParticipant,GenericSubscriber,GenericPublisher,GenericPublisherQos,GenericSubscriberListener,GenericPublisherListener,GenericDataReaderListener,GenericDataWriterListener,GenericDataReaderQos,GenericDataWriterQos,GenericDataWriter,GenericDataReader,GenericTopicDescription>

Type Parameters:

GenericTopicTypeSupport -

GenericTopic -

GenericContentFilteredTopic -

GenericDomainParticipantQos -

GenericSubscriberQos -

GenericDomainParticipant -

GenericSubscriber -

GenericPublisher -

GenericPublisherQos -

GenericSubscriberListener -

GenericPublisherListener -

GenericDataReaderListener -

GenericDataWriterListener -

GenericDataReaderQos -

GenericDataWriterQos -

GenericDataWriter -

GenericDataReader -

GenericTopicDescription -

All Known Implementing Classes:

CoreDXAbstractionComponent, RTIAbstractionComponent

public interface DDSStandardAPI<GenericTopic,GenericTopicTypeSupport,GenericContentFilteredTopic,GenericDomainParticipantQos,GenericSubscriberQos,GenericDomainParticipant,GenericSubscriber,GenericPublisher,GenericPublisherQos,GenericSubscriberListener,GenericPublisherListener,GenericDataReaderListener,GenericDataWriterListener,GenericDataReaderQos,GenericDataWriterQos,GenericDataWriter,GenericDataReader,GenericTopicDescription>

This interface permits that all DDS implementations have the same API, although the objects manipulated are different from each DDS Vendor.

Author:

Rafael Oliveira Vasconcelos

Method Summary

Methods

Modifier and Type	Method and Description
boolean	close() Deletes all DDS entities
GenericContentFilteredTopic	createContentFilteredTopic(java.lang.String topicName, GenericTopic topic, java.lang.String logicExpression, java.util.List<java.lang.String> parameters) Creates a ContentFilteredTopic
GenericDataReader	createDataReader(GenericTopicDescription topicDescription, GenericDataReaderQos dr_qos, GenericDataReaderListener dr_listener) Creates a DataReader
GenericDataWriter	createDataWriter(GenericTopic topic, GenericDataWriterQos dw_qos, GenericDataWriterListener dw_listener) Creates a DataWriter
GenericDomainParticipant	createParticipant(long domainID) Creates a participant
GenericDomainParticipant	createParticipant(long domainID, GenericDomainParticipantQos qos) Creates a participant on non-Android Device
GenericDomainParticipant	createParticipant(long domainID, GenericDomainParticipantQos qos, java.lang.String license) Creates a participant on Android Device
GenericDomainParticipant	createParticipant(java.lang.String domainID) Creates a participant
GenericDomainParticipant	createParticipant(java.lang.String domainID, GenericDomainParticipantQos qos) Creates a participant on non-Android Device
GenericDomainParticipant	createParticipant(java.lang.String domainID, GenericDomainParticipantQos qos, java.lang.String license) Creates a participant on Android Device
GenericPublisher	createPublisher(GenericPublisherQos pub_qos, GenericPublisherListener pub_listener) Creates a publisher
GenericSubscriber	createSubscriber(GenericSubscriberQos sub_qos, GenericSubscriberListener sub_listener) Creates a subscriber
GenericTopic	createTopic(GenericTopicTypeSupport topicTypeSupport, java.lang.String topicName) Creates a Generic Topic
GenericTopic	createTopic(java.lang.String typeName, java.lang.String topicName) Creates a Generic Topic
boolean	deleteDataReader(java.lang.String dataReaderName) Deletes the specified DataReader
boolean	deleteDataWriter(java.lang.String dataWriterName) Deletes the specified DataWriter
boolean	deleteParticipant() Deletes the participant
boolean	deletePublisher() Deletes the publisher
boolean	deleteSubscriber() Deletes the subscriber
boolean	deleteTopic(GenericTopic topic) Deletes a topic
GenericDataReaderQos	getDefaultDataReaderQoS() Gets the default Data Reader QoS
GenericDataWriterQos	getDefaultDataWriterQoS() Gets the default Data Writer QoS
boolean	writeTopic(java.lang.String topicName, java.lang.Object topic) Sends a Topic over the DDS Domain

Method Detail

createParticipant

GenericDomainParticipant createParticipant(long domainID)

Creates a participant

Parameters:

domainID -

Returns:

The DomainParticipant created

createParticipant

GenericDomainParticipant createParticipant(java.lang.String domainID)

Creates a participant

Parameters:

domainID -

Returns:

The DomainParticipant created

createParticipant

GenericDomainParticipant createParticipant(long domainID,
                                         GenericDomainParticipantQos qos)

Creates a participant on non-Android Device

Parameters:

domainID -

qos -

Returns:

The DomainParticipant created

createParticipant

GenericDomainParticipant createParticipant(java.lang.String domainID,
                                         GenericDomainParticipantQos qos)

Creates a participant on non-Android Device

Parameters:

domainID -

qos -

Returns:

The DomainParticipant created

createParticipant

GenericDomainParticipant createParticipant(long domainID,
                                         GenericDomainParticipantQos qos,
                                         java.lang.String license)

Creates a participant on Android Device

Parameters:

domainID -

qos -

license - DDS Vendor String license

Returns:

The DomainParticipant created

createParticipant

GenericDomainParticipant createParticipant(java.lang.String domainID,
                                         GenericDomainParticipantQos qos,
                                         java.lang.String license)

Creates a participant on Android Device

Parameters:

domainID -

qos -

license - CoreDX´s String license

Returns:

The DomainParticipant created

createSubscriber

GenericSubscriber createSubscriber(GenericSubscriberQos sub_qos,
                                 GenericSubscriberListener sub_listener)

Creates a subscriber

Parameters:

sub_qos - Subscriber´s QoS or null

sub_listener - Subscriber´s Listener or null

Returns:

Subscriber created

createPublisher

GenericPublisher createPublisher(GenericPublisherQos pub_qos,
                               GenericPublisherListener pub_listener)

Creates a publisher

Parameters:

pub_qos - Publisher´s QoS or null

pub_listener - Publisher´s Listener or null

Returns:

Publisher created

createTopic

GenericTopic createTopic(java.lang.String typeName,
                       java.lang.String topicName)

Creates a Generic Topic

Parameters:

typeName - The Class Name. E.g. "String"

topicName - A name for the topic. E.g. "HelloWorldTopic"

Returns:

The Generic Topic created

createTopic

GenericTopic createTopic(GenericTopicTypeSupport topicTypeSupport,
                       java.lang.String topicName)

Creates a Generic Topic

Parameters:

topicTypeSupport - The instance of the GenericTopicTypeSupport class

topicName - A name for the topic. E.g. "HelloWorldTopic"

Returns:

The Generic Topic created

createContentFilteredTopic

GenericContentFilteredTopic createContentFilteredTopic(java.lang.String topicName,
                                                     GenericTopic topic,
                                                     java.lang.String logicExpression,
                                                     java.util.List<java.lang.String> parameters)

Creates a ContentFilteredTopic

Parameters:

topicName - The Class Name. E.g. "Integer"

topic - A name for the topic. E.g. "HelloWorldFilteredTopic"

logicExpression - SQL Expression

parameters - Parameters in the SQL Expression

Returns:

The ContentFilteredTopic created

createDataReader

GenericDataReader createDataReader(GenericTopicDescription topicDescription,
                                 GenericDataReaderQos dr_qos,
                                 GenericDataReaderListener dr_listener)

Creates a DataReader

Parameters:

topicDescription - The Topic to associate to DataReader

dr_qos - DataReader´s QoS

dr_listener - DataReader´s Listener

Returns:

Generic DataReader created

createDataWriter

GenericDataWriter createDataWriter(GenericTopic topic,
                                 GenericDataWriterQos dw_qos,
                                 GenericDataWriterListener dw_listener)

Creates a DataWriter

Parameters:

topic - The Topic to associate to DataWriter

dw_qos - DataWriter´s QoS

dw_listener - DataWriter´s Listener or null

Returns:

Role Topic DataWriter created

getDefaultDataReaderQoS

GenericDataReaderQos getDefaultDataReaderQoS()

Gets the default Data Reader QoS

Returns:

The default Data Reader QoS

getDefaultDataWriterQoS

GenericDataWriterQos getDefaultDataWriterQoS()

Gets the default Data Writer QoS

Returns:

The default Data Writer QoS

writeTopic

boolean writeTopic(java.lang.String topicName,
                 java.lang.Object topic)

Sends a Topic over the DDS Domain

Parameters:

topicName - The name for the topic. E.g. "HelloWorldTopic"

topic - The object that represents the topic sample

Returns:

True if the topic was written

deleteParticipant

boolean deleteParticipant()

Deletes the participant

Returns:

True if the Participant was successfully deleted

deletePublisher

boolean deletePublisher()

Deletes the publisher

Returns:

True if the Publisher was successfully deleted

deleteSubscriber

boolean deleteSubscriber()

Deletes the subscriber

Returns:

True if the Subscriber was successfully deleted

deleteDataReader

boolean deleteDataReader(java.lang.String dataReaderName)

Deletes the specified DataReader

Parameters:

dataReaderName -

Returns:

True if the specified DataReader was successfully deleted

deleteDataWriter

boolean deleteDataWriter(java.lang.String dataWriterName)

Deletes the specified DataWriter

Parameters:

dataWriterName -

Returns:

True if the specified DataWriterwas successfully deleted

deleteTopic

boolean deleteTopic(GenericTopic topic)

Deletes a topic

Parameters:

topic -

Returns:

True if the Topic was successfully deleted

close

boolean close()

Deletes all DDS entities

Returns:

True if all DDS entities were successfully deleted