RTI Connext .NET API (legacy)  Version 6.1.1
RTI.Connext.Infrastructure.Sample< T > Struct Template Reference

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

Properties

SampleInfo Info [get, set]
 Gets or sets the sample information. More...
 
Data [get, set]
 Gets or sets the data this sample contains. More...
 
SampleIdentity_t Identity [get]
 Gets the identity of this sample. More...
 
SampleIdentity_t RelatedIdentity [get]
 Gets the identity of a sample that is related to this one. More...
 

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
RTI::Connext::RequestReply::Requester<TReq,TRep>::ReceiveReply(Sample<TRep>,Duration_t)
RTI::Connext::RequestReply::Requester<TReq,TRep>::TakeReply(Sample<TRep>)
RTI::Connext::RequestReply::Replier<TReq,TRep>::ReceiveRequest(Sample<TReq>,Duration_t)

Property Documentation

◆ Info

Gets or sets the sample information.

See also
DDS::SampleInfo
Basic Requester example

◆ Data

Gets or sets the data this sample contains.

See also
Basic Requester example

Referenced by RTI.Connext.Infrastructure.LoanedSamples< T >.Contains().

◆ Identity

Gets the identity of this sample.

The identity is assigned by the middleware upon reception.

See also
Correlating requests and replies

◆ RelatedIdentity

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

When a 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 DDS::SampleIdentity_t::UNKNOWN_SAMPLE_IDENTITY if there is not a related sample.
See also
RTI::Connext::RequestReply::Requester<TReq,TRep>::ReceiveReply(Sample<TRep>,Duration_t)
Correlating requests and replies