RTI Connext Java API  Version 5.0.0
Sample< T > Interface Reference

A data sample and related info received from the middleware. More...

Inheritance diagram for Sample< T >:
SampleData< T > Copyable

Classes

interface  Iterator< T >
 Provides access to a collection of middleware-loaned samples. More...
 

Public Member Functions

SampleInfo getInfo ()
 Gets the sample information.
 
SampleIdentity_t getRelatedIdentity ()
 Gets the identity of a sample that is related to this one.
 
- Public Member Functions inherited from SampleData< T >
getData ()
 Gets the data this sample contains.
 
SampleIdentity_t getIdentity ()
 Gets the identity of this sample.
 
- Public Member Functions inherited from Copyable
Object copy_from (Object src)
 Copy value of a data type from source.
 

Detailed Description

A data sample and related info received from the middleware.

Samples contain data received from the middleware and information associated to the data.

Template Parameters
TThe data type that this sample contains
See Also
com.rti.connext.requestreply.Requester<TReq,TRep>.receiveReply(Sample<TRep>,Duration_t)
com.rti.connext.requestreply.Requester<TReq,TRep>.takeReply(Sample<TRep>)
com.rti.connext.requestreply.Replier<TReq,TRep>.receiveRequest(Sample<TReq>,Duration_t)

Member Function Documentation

SampleInfo getInfo ( )

Gets the sample information.

See Also
com.rti.dds.subscription.SampleInfo
Basic Requester example
SampleIdentity_t getRelatedIdentity ( )

Gets the identity of a sample that is related to this one.

When a com.rti.connext.requestreply.Requester<TReq,TRep> receives a reply, the reply Sample contains the identity of the related request.

Returns
The identity of another sample that is related to this one, or com.rti.dds.infrastructure.SampleIdentity_t.SampleIdentity_t.UNKNOWN_SAMPLE_IDENTITY if there is not a related sample.
See Also
com.rti.connext.requestreply.Requester<TReq,TRep>.receiveReply(Sample<TRep>,Duration_t)
Correlating requests and replies

RTI Connext Java API Version 5.0.0 Copyright © Thu Aug 30 2012 Real-Time Innovations, Inc