Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.omg.dds.sub
Interface DataReader<TYPE>

All Superinterfaces:
DDSObject, DomainEntity<DataReader<TYPE>,Subscriber,DataReaderListener<TYPE>,DataReaderQos>, Entity<DataReader<TYPE>,DataReaderListener<TYPE>,DataReaderQos>
All Known Subinterfaces:
BytesDataReader, KeyedBytesDataReader, KeyedStringDataReader, StringDataReader
public interface DataReader<TYPE>
extends DomainEntity<DataReader<TYPE>,Subscriber,DataReaderListener<TYPE>,DataReaderQos>

Method Summary
<OTHER> DataReader<OTHER>
cast()
          Cast this data reader to the given type, or throw an exception if the cast fails.
 void closeContainedEntities()
           
 QueryCondition<TYPE> createQueryCondition(java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates, java.lang.String queryExpression, java.util.List<java.lang.String> queryParameters)
           
 QueryCondition<TYPE> createQueryCondition(java.lang.String queryExpression, java.util.List<java.lang.String> queryParameters)
           
 ReadCondition<TYPE> createReadCondition()
           
 ReadCondition<TYPE> createReadCondition(java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 Sample<TYPE> createSample()
          Create and return a new Sample of the same type as may be accessed by this DataReader.
 TYPE getKeyValue(TYPE keyHolder, InstanceHandle handle)
           
 LivelinessChangedStatus<TYPE> getLivelinessChangedStatus(LivelinessChangedStatus<TYPE> status)
           
 PublicationBuiltinTopicData getMatchedPublicationData(PublicationBuiltinTopicData publicationData, InstanceHandle publicationHandle)
           
 java.util.Collection<InstanceHandle> getMatchedPublications(java.util.Collection<InstanceHandle> publicationHandles)
           
 RequestedDeadlineMissedStatus<TYPE> getRequestedDeadlineMissedStatus(RequestedDeadlineMissedStatus<TYPE> status)
           
 RequestedIncompatibleQosStatus<TYPE> getRequestedIncompatibleQosStatus(RequestedIncompatibleQosStatus<TYPE> status)
           
 SampleLostStatus<TYPE> getSampleLostStatus(SampleLostStatus<TYPE> status)
           
 SampleRejectedStatus<TYPE> getSampleRejectedStatus(SampleRejectedStatus<TYPE> status)
           
 SubscriptionMatchedStatus<TYPE> getSubscriptionMatchedStatus(SubscriptionMatchedStatus<TYPE> status)
           
 TopicDescription<TYPE> getTopicDescription()
           
 java.lang.Class<TYPE> getType()
           
 ModifiableInstanceHandle lookupInstance(ModifiableInstanceHandle handle, TYPE keyHolder)
           
 Sample.Iterator<TYPE> read()
           
 Sample.Iterator<TYPE> read(java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 Sample.Iterator<TYPE> read(InstanceHandle handle)
           
 Sample.Iterator<TYPE> read(InstanceHandle handle, java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 void read(java.util.List<Sample<TYPE>> samples)
          Copy samples into the provided collection, overwriting any samples that might already be present.
 void read(java.util.List<Sample<TYPE>> samples, InstanceHandle handle)
           
 void read(java.util.List<Sample<TYPE>> samples, InstanceHandle handle, int maxSamples, java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 void read(java.util.List<Sample<TYPE>> samples, int maxSamples, java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 void read(java.util.List<Sample<TYPE>> samples, int maxSamples, ReadCondition<TYPE> condition)
           
 void read(java.util.List<Sample<TYPE>> samples, ReadCondition<TYPE> condition)
           
 Sample.Iterator<TYPE> read(ReadCondition<TYPE> condition)
           
 Sample.Iterator<TYPE> readNext(InstanceHandle previousHandle)
           
 Sample.Iterator<TYPE> readNext(InstanceHandle previousHandle, java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 Sample.Iterator<TYPE> readNext(InstanceHandle previousHandle, ReadCondition<TYPE> condition)
           
 void readNext(java.util.List<Sample<TYPE>> samples, InstanceHandle previousHandle)
           
 void readNext(java.util.List<Sample<TYPE>> samples, InstanceHandle previousHandle, int maxSamples, java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 void readNext(java.util.List<Sample<TYPE>> samples, InstanceHandle previousHandle, int maxSamples, ReadCondition<TYPE> condition)
           
 void readNext(java.util.List<Sample<TYPE>> samples, InstanceHandle previousHandle, ReadCondition<TYPE> condition)
           
 boolean readNext(Sample<TYPE> sample)
           
 Sample.Iterator<TYPE> take()
           
 Sample.Iterator<TYPE> take(java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 Sample.Iterator<TYPE> take(InstanceHandle handle)
           
 Sample.Iterator<TYPE> take(InstanceHandle handle, java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 void take(java.util.List<Sample<TYPE>> samples)
           
 void take(java.util.List<Sample<TYPE>> samples, InstanceHandle handle)
           
 void take(java.util.List<Sample<TYPE>> samples, InstanceHandle handle, int maxSamples, java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 void take(java.util.List<Sample<TYPE>> samples, int maxSamples, java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 void take(java.util.List<Sample<TYPE>> samples, int maxSamples, ReadCondition<TYPE> condition)
           
 void take(java.util.List<Sample<TYPE>> samples, ReadCondition<TYPE> condition)
           
 Sample.Iterator<TYPE> take(ReadCondition<TYPE> condition)
           
 Sample.Iterator<TYPE> takeNext(InstanceHandle previousHandle)
           
 Sample.Iterator<TYPE> takeNext(InstanceHandle previousHandle, java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 Sample.Iterator<TYPE> takeNext(InstanceHandle previousHandle, ReadCondition<TYPE> condition)
           
 void takeNext(java.util.List<Sample<TYPE>> samples, InstanceHandle previousHandle)
           
 void takeNext(java.util.List<Sample<TYPE>> samples, InstanceHandle previousHandle, int maxSamples, java.util.Collection<SampleState> sampleStates, java.util.Collection<ViewState> viewStates, java.util.Collection<InstanceState> instanceStates)
           
 void takeNext(java.util.List<Sample<TYPE>> samples, InstanceHandle previousHandle, int maxSamples, ReadCondition<TYPE> condition)
           
 void takeNext(java.util.List<Sample<TYPE>> samples, InstanceHandle previousHandle, ReadCondition<TYPE> condition)
           
 boolean takeNext(Sample<TYPE> sample)
           
 void waitForHistoricalData(Duration maxWait)
           
 void waitForHistoricalData(long maxWait, java.util.concurrent.TimeUnit unit)
           
 
Methods inherited from interface org.omg.dds.core.DomainEntity
getParent
 
Methods inherited from interface org.omg.dds.core.Entity
close, enable, getInstanceHandle, getListener, getQos, getStatusChanges, getStatusCondition, retain, setListener, setQos, setQos
 
Methods inherited from interface org.omg.dds.core.DDSObject
getBootstrap
 

Method Detail

getType

java.lang.Class<TYPE> getType()
Returns:
the type parameter if this object's class.

cast

<OTHER> DataReader<OTHER> cast()
Cast this data reader to the given type, or throw an exception if the cast fails.

Type Parameters:
OTHER - The type of the data subscribed to by this reader, according to the caller.
Returns:
this data reader
Throws:
java.lang.ClassCastException - if the cast fails

createReadCondition

ReadCondition<TYPE> createReadCondition()

createReadCondition

ReadCondition<TYPE> createReadCondition(java.util.Collection<SampleState> sampleStates,
                                        java.util.Collection<ViewState> viewStates,
                                        java.util.Collection<InstanceState> instanceStates)

createQueryCondition

QueryCondition<TYPE> createQueryCondition(java.lang.String queryExpression,
                                          java.util.List<java.lang.String> queryParameters)

createQueryCondition

QueryCondition<TYPE> createQueryCondition(java.util.Collection<SampleState> sampleStates,
                                          java.util.Collection<ViewState> viewStates,
                                          java.util.Collection<InstanceState> instanceStates,
                                          java.lang.String queryExpression,
                                          java.util.List<java.lang.String> queryParameters)

closeContainedEntities

void closeContainedEntities()

getTopicDescription

TopicDescription<TYPE> getTopicDescription()

getSampleRejectedStatus

SampleRejectedStatus<TYPE> getSampleRejectedStatus(SampleRejectedStatus<TYPE> status)

getLivelinessChangedStatus

LivelinessChangedStatus<TYPE> getLivelinessChangedStatus(LivelinessChangedStatus<TYPE> status)

getRequestedDeadlineMissedStatus

RequestedDeadlineMissedStatus<TYPE> getRequestedDeadlineMissedStatus(RequestedDeadlineMissedStatus<TYPE> status)

getRequestedIncompatibleQosStatus

RequestedIncompatibleQosStatus<TYPE> getRequestedIncompatibleQosStatus(RequestedIncompatibleQosStatus<TYPE> status)

getSubscriptionMatchedStatus

SubscriptionMatchedStatus<TYPE> getSubscriptionMatchedStatus(SubscriptionMatchedStatus<TYPE> status)

getSampleLostStatus

SampleLostStatus<TYPE> getSampleLostStatus(SampleLostStatus<TYPE> status)

waitForHistoricalData

void waitForHistoricalData(Duration maxWait)
                           throws java.util.concurrent.TimeoutException
Throws:
java.util.concurrent.TimeoutException

waitForHistoricalData

void waitForHistoricalData(long maxWait,
                           java.util.concurrent.TimeUnit unit)
                           throws java.util.concurrent.TimeoutException
Throws:
java.util.concurrent.TimeoutException

getMatchedPublications

java.util.Collection<InstanceHandle> getMatchedPublications(java.util.Collection<InstanceHandle> publicationHandles)

getMatchedPublicationData

PublicationBuiltinTopicData getMatchedPublicationData(PublicationBuiltinTopicData publicationData,
                                                      InstanceHandle publicationHandle)

createSample

Sample<TYPE> createSample()
Create and return a new Sample of the same type as may be accessed by this DataReader. Applications may use this method, for example, to preallocate samples to be overwritten by the read and/or take methods of this interface.

See Also:
read(List), take(List)

read

Sample.Iterator<TYPE> read()
Returns:
a non-null unmodifiable iterator over loaned samples.

read

Sample.Iterator<TYPE> read(java.util.Collection<SampleState> sampleStates,
                           java.util.Collection<ViewState> viewStates,
                           java.util.Collection<InstanceState> instanceStates)

read

void read(java.util.List<Sample<TYPE>> samples)
Copy samples into the provided collection, overwriting any samples that might already be present.

read

void read(java.util.List<Sample<TYPE>> samples,
          int maxSamples,
          java.util.Collection<SampleState> sampleStates,
          java.util.Collection<ViewState> viewStates,
          java.util.Collection<InstanceState> instanceStates)

take

Sample.Iterator<TYPE> take()
Returns:
a non-null unmodifiable iterator over loaned samples.

take

Sample.Iterator<TYPE> take(java.util.Collection<SampleState> sampleStates,
                           java.util.Collection<ViewState> viewStates,
                           java.util.Collection<InstanceState> instanceStates)

take

void take(java.util.List<Sample<TYPE>> samples)

take

void take(java.util.List<Sample<TYPE>> samples,
          int maxSamples,
          java.util.Collection<SampleState> sampleStates,
          java.util.Collection<ViewState> viewStates,
          java.util.Collection<InstanceState> instanceStates)

read

Sample.Iterator<TYPE> read(ReadCondition<TYPE> condition)
Returns:
a non-null unmodifiable iterator over loaned samples.

read

void read(java.util.List<Sample<TYPE>> samples,
          ReadCondition<TYPE> condition)

read

void read(java.util.List<Sample<TYPE>> samples,
          int maxSamples,
          ReadCondition<TYPE> condition)

take

Sample.Iterator<TYPE> take(ReadCondition<TYPE> condition)
Returns:
a non-null unmodifiable iterator over loaned samples.

take

void take(java.util.List<Sample<TYPE>> samples,
          ReadCondition<TYPE> condition)

take

void take(java.util.List<Sample<TYPE>> samples,
          int maxSamples,
          ReadCondition<TYPE> condition)

readNext

boolean readNext(Sample<TYPE> sample)
Returns:
true if data was read or false if no data was available.

takeNext

boolean takeNext(Sample<TYPE> sample)
Returns:
true if data was taken or false if no data was available.

read

Sample.Iterator<TYPE> read(InstanceHandle handle)
Returns:
a non-null unmodifiable iterator over loaned samples.

read

Sample.Iterator<TYPE> read(InstanceHandle handle,
                           java.util.Collection<SampleState> sampleStates,
                           java.util.Collection<ViewState> viewStates,
                           java.util.Collection<InstanceState> instanceStates)

read

void read(java.util.List<Sample<TYPE>> samples,
          InstanceHandle handle)

read

void read(java.util.List<Sample<TYPE>> samples,
          InstanceHandle handle,
          int maxSamples,
          java.util.Collection<SampleState> sampleStates,
          java.util.Collection<ViewState> viewStates,
          java.util.Collection<InstanceState> instanceStates)

take

Sample.Iterator<TYPE> take(InstanceHandle handle)
Returns:
a non-null unmodifiable iterator over loaned samples.

take

Sample.Iterator<TYPE> take(InstanceHandle handle,
                           java.util.Collection<SampleState> sampleStates,
                           java.util.Collection<ViewState> viewStates,
                           java.util.Collection<InstanceState> instanceStates)

take

void take(java.util.List<Sample<TYPE>> samples,
          InstanceHandle handle)

take

void take(java.util.List<Sample<TYPE>> samples,
          InstanceHandle handle,
          int maxSamples,
          java.util.Collection<SampleState> sampleStates,
          java.util.Collection<ViewState> viewStates,
          java.util.Collection<InstanceState> instanceStates)

readNext

Sample.Iterator<TYPE> readNext(InstanceHandle previousHandle)
Returns:
a non-null unmodifiable iterator over loaned samples.

readNext

Sample.Iterator<TYPE> readNext(InstanceHandle previousHandle,
                               java.util.Collection<SampleState> sampleStates,
                               java.util.Collection<ViewState> viewStates,
                               java.util.Collection<InstanceState> instanceStates)

readNext

void readNext(java.util.List<Sample<TYPE>> samples,
              InstanceHandle previousHandle)

readNext

void readNext(java.util.List<Sample<TYPE>> samples,
              InstanceHandle previousHandle,
              int maxSamples,
              java.util.Collection<SampleState> sampleStates,
              java.util.Collection<ViewState> viewStates,
              java.util.Collection<InstanceState> instanceStates)

takeNext

Sample.Iterator<TYPE> takeNext(InstanceHandle previousHandle)
Returns:
a non-null unmodifiable iterator over loaned samples.

takeNext

Sample.Iterator<TYPE> takeNext(InstanceHandle previousHandle,
                               java.util.Collection<SampleState> sampleStates,
                               java.util.Collection<ViewState> viewStates,
                               java.util.Collection<InstanceState> instanceStates)

takeNext

void takeNext(java.util.List<Sample<TYPE>> samples,
              InstanceHandle previousHandle)

takeNext

void takeNext(java.util.List<Sample<TYPE>> samples,
              InstanceHandle previousHandle,
              int maxSamples,
              java.util.Collection<SampleState> sampleStates,
              java.util.Collection<ViewState> viewStates,
              java.util.Collection<InstanceState> instanceStates)

readNext

Sample.Iterator<TYPE> readNext(InstanceHandle previousHandle,
                               ReadCondition<TYPE> condition)
Returns:
a non-null unmodifiable iterator over loaned samples.

readNext

void readNext(java.util.List<Sample<TYPE>> samples,
              InstanceHandle previousHandle,
              ReadCondition<TYPE> condition)

readNext

void readNext(java.util.List<Sample<TYPE>> samples,
              InstanceHandle previousHandle,
              int maxSamples,
              ReadCondition<TYPE> condition)

takeNext

Sample.Iterator<TYPE> takeNext(InstanceHandle previousHandle,
                               ReadCondition<TYPE> condition)
Returns:
a non-null unmodifiable iterator over loaned samples.

takeNext

void takeNext(java.util.List<Sample<TYPE>> samples,
              InstanceHandle previousHandle,
              ReadCondition<TYPE> condition)

takeNext

void takeNext(java.util.List<Sample<TYPE>> samples,
              InstanceHandle previousHandle,
              int maxSamples,
              ReadCondition<TYPE> condition)

getKeyValue

TYPE getKeyValue(TYPE keyHolder,
                 InstanceHandle handle)

lookupInstance

ModifiableInstanceHandle lookupInstance(ModifiableInstanceHandle handle,
                                        TYPE keyHolder)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2010 Real-Time Innovations, Inc. (RTI)
Copyright © 2010 PrismTech, Ltd.
Copyright © 2010 Object Management Group, Inc. (OMG)
All Rights Reserved.