dds::sub::Sample< T > Class Template Reference

This class encapsulates the data and info meta-data associated with DDS samples. More...

#include "Sample.hpp"

Inherits dds::core::Value< D >.

Public Types
typedef T	DataType

Public Member Functions
	Sample ()
	Sample (const Sample &other)
	Sample (const T &data, const SampleInfo &info)
const DataType &	data () const
void	data (const DataType &data)
const SampleInfo &	info () const
void	info (const SampleInfo &info)
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator== (const Value &other) const

Detailed Description

template<typename T>
class dds::sub::Sample< T >

This class encapsulates the data and info meta-data associated with DDS samples.

It is normally used with dds::sub::LoanedSamples:

dds::sub::LoanedSamples<Foo::Bar> samples = reader.read();
dds::sub::LoanedSamples<Foo::Bar>::const_iterator it;
for (it = samples.begin(); it != samples.end(); ++it) {
    const dds::sub::Sample<Foo::Bar>& sample = *it;
    const Foo::Bar& data = sample.data();
    const dds::sub::SampleInfo& info = sample.info();
    // Use sample data and meta information.
}

Or more implicitly:

dds::sub::LoanedSamples<Foo::Bar> samples = reader.read();
dds::sub::LoanedSamples<Foo::Bar>::const_iterator it;
for (it = samples.begin(); it != samples.end(); ++it) {
    const Foo::Bar& data = it->data();
    const dds::sub::SampleInfo& info = it->info();
    // Use sample data and meta information.
}

See also

DataSample for more information

SampleInfo for more information

Subscription for more information

Definition at line 30 of file Sample.hpp.

Member Typedef Documentation

DataType

template<typename T>

typedef T dds::sub::Sample< T >::DataType

Convenience typedef for the type of the data sample.

Definition at line 72 of file Sample.hpp.

Constructor & Destructor Documentation

Sample() [1/3]

template<typename T>

dds::sub::Sample< T >::Sample

(

)

Create a sample with invalid data.

Sample() [2/3]

template<typename T>

dds::sub::Sample< T >::Sample	(	const T &	data,
		const SampleInfo &	info
	)

Creates a Sample instance.

Parameters

data	the data
info	the sample info

Sample() [3/3]

template<typename T>

dds::sub::Sample< T >::Sample

(

const Sample< T > &

other

)

Copies a sample instance.

Parameters

other

the sample instance to copy

Member Function Documentation

data() [1/2]

template<typename T>

const DataType& dds::sub::Sample< T >::data

(

)

const

Gets the data.

Returns

the data

data() [2/2]

template<typename T>

void dds::sub::Sample< T >::data

(

const DataType &

data

)

Sets the data.

Parameters

data

the data

info() [1/2]

template<typename T>

const SampleInfo& dds::sub::Sample< T >::info

(

)

const

Gets the info.

Returns

the info

info() [2/2]

template<typename T>

void dds::sub::Sample< T >::info

(

const SampleInfo &

info

)

Sets the info.

Parameters

info

the info

operator!=()

template<typename D >

bool dds::core::Value< D >::operator!= ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if not equal

operator->() [1/2]

template<typename D >

D* dds::core::Value< D >::operator-> ( )

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

operator->() [2/2]

template<typename D >

const D* dds::core::Value< D >::operator-> ( ) const

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

operator==()

template<typename D >

bool dds::core::Value< D >::operator== ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if equal

---

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

• dds/sub/Sample.hpp