OpenDDS::DCPS::Sample_T< NativeType > Class Template Reference

#include <Sample.h>

Inheritance diagram for OpenDDS::DCPS::Sample_T< NativeType >:

Collaboration diagram for OpenDDS::DCPS::Sample_T< NativeType >:

Public Types
typedef DDSTraits< NativeType >	TraitsType
typedef MarshalTraits< NativeType >	MarshalTraitsType
typedef RcHandle< Sample_T< NativeType > >	Rch
typedef DCPS::KeyOnly< const NativeType >	KeyOnlyType
typedef DCPS::KeyOnly< NativeType >	MutableKeyOnlyType
typedef XTypes::DynamicDataAdapter< NativeType >	DynamicDataImpl
Public Types inherited from OpenDDS::DCPS::Sample
enum	Mutability { Mutable, ReadOnly }
enum	Extent { Full, KeyOnly, NestedKeyOnly }

Public Member Functions
	Sample_T (const NativeType &data, Extent extent=Full)
	Sample_T (const NativeType *data, Extent extent=Full)
	Sample_T (NativeType &data, Extent extent=Full)
	Sample_T (NativeType *data, Extent extent=Full)
virtual	~Sample_T ()
const NativeType &	data () const
NativeType &	mutable_data () const
KeyOnlyType	key_only_data () const
MutableKeyOnlyType	mutable_key_only_data () const
bool	serialize (Serializer &ser) const
bool	deserialize (Serializer &ser)
size_t	serialized_size (const Encoding &enc) const
bool	compare (const Sample &other) const
bool	to_message_block (ACE_Message_Block &mb) const
bool	from_message_block (const ACE_Message_Block &mb)
Sample_rch	copy (Mutability mutability, Extent extent) const
DDS::DynamicData_var	get_dynamic_data (DDS::DynamicType_ptr type) const
const void *	native_data () const
bool	eval (FilterEvaluator &evaluator, const DDS::StringSeq &params) const
Public Member Functions inherited from OpenDDS::DCPS::Sample
	Sample ()
	Sample (Mutability mutability, Extent extent)
virtual	~Sample ()
bool	read_only () const
bool	key_only () const
Sample_rch	copy (Mutability mutability) const
Public Member Functions inherited from OpenDDS::DCPS::RcObject
virtual	~RcObject ()
virtual void	_add_ref ()
virtual void	_remove_ref ()
long	ref_count () const
WeakObject *	_get_weak_object () const

Private Attributes
const bool	owns_data_
const NativeType *	data_
DDS::DynamicData_var	dynamic_data_

Additional Inherited Members
Protected Member Functions inherited from OpenDDS::DCPS::RcObject
	RcObject ()
Protected Attributes inherited from OpenDDS::DCPS::Sample
Mutability	mutability_
Extent	extent_

Detailed Description

template<typename NativeType>
class OpenDDS::DCPS::Sample_T< NativeType >

Definition at line 105 of file Sample.h.

Member Typedef Documentation

DynamicDataImpl

template<typename NativeType>

typedef XTypes::DynamicDataAdapter<NativeType> OpenDDS::DCPS::Sample_T< NativeType >::DynamicDataImpl

Definition at line 113 of file Sample.h.

KeyOnlyType

template<typename NativeType>

typedef DCPS::KeyOnly<const NativeType> OpenDDS::DCPS::Sample_T< NativeType >::KeyOnlyType

Definition at line 110 of file Sample.h.

MarshalTraitsType

template<typename NativeType>

typedef MarshalTraits<NativeType> OpenDDS::DCPS::Sample_T< NativeType >::MarshalTraitsType

Definition at line 108 of file Sample.h.

MutableKeyOnlyType

template<typename NativeType>

typedef DCPS::KeyOnly<NativeType> OpenDDS::DCPS::Sample_T< NativeType >::MutableKeyOnlyType

Definition at line 111 of file Sample.h.

Rch

template<typename NativeType>

typedef RcHandle<Sample_T<NativeType> > OpenDDS::DCPS::Sample_T< NativeType >::Rch

Definition at line 109 of file Sample.h.

TraitsType

template<typename NativeType>

typedef DDSTraits<NativeType> OpenDDS::DCPS::Sample_T< NativeType >::TraitsType

Definition at line 107 of file Sample.h.

Constructor & Destructor Documentation

Sample_T() [1/4]

template<typename NativeType>

OpenDDS::DCPS::Sample_T< NativeType >::Sample_T ( const NativeType &  data, Extent  extent = Full  )

inlineexplicit

Definition at line 116 of file Sample.h.

References if().

    : Sample(ReadOnly, extent)
    , owns_data_(false)
    , data_(&data)
#if OPENDDS_HAS_DYNAMIC_DATA_ADAPTER
    , dynamic_data_(0)
#endif
  {
  }

Sample_T() [2/4]

template<typename NativeType>

OpenDDS::DCPS::Sample_T< NativeType >::Sample_T ( const NativeType *  data, Extent  extent = Full  )

inlineexplicit

Definition at line 126 of file Sample.h.

References if().

    : Sample(ReadOnly, extent)
    , owns_data_(true)
    , data_(data)
#if OPENDDS_HAS_DYNAMIC_DATA_ADAPTER
    , dynamic_data_(0)
#endif
  {
  }

Sample_T() [3/4]

template<typename NativeType>

OpenDDS::DCPS::Sample_T< NativeType >::Sample_T ( NativeType &  data, Extent  extent = Full  )

inlineexplicit

Definition at line 136 of file Sample.h.

References if().

    : Sample(Mutable, extent)
    , owns_data_(false)
    , data_(&data)
#if OPENDDS_HAS_DYNAMIC_DATA_ADAPTER
    , dynamic_data_(0)
#endif
  {
  }

Sample_T() [4/4]

template<typename NativeType>

OpenDDS::DCPS::Sample_T< NativeType >::Sample_T ( NativeType *  data, Extent  extent = Full  )

inlineexplicit

Definition at line 146 of file Sample.h.

References if().

    : Sample(Mutable, extent)
    , owns_data_(true)
    , data_(data)
#if OPENDDS_HAS_DYNAMIC_DATA_ADAPTER
    , dynamic_data_(0)
#endif
  {
  }

~Sample_T()

template<typename NativeType>

virtual OpenDDS::DCPS::Sample_T< NativeType >::~Sample_T ( )

inlinevirtual

Definition at line 156 of file Sample.h.

  {
    if (owns_data_) {
      delete data_;
    }
  }

Member Function Documentation

compare()

template<typename NativeType>

bool OpenDDS::DCPS::Sample_T< NativeType >::compare ( const Sample &  other ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 211 of file Sample.h.

References OpenDDS::DCPS::Sample_T< NativeType >::data_, and OPENDDS_ASSERT.

  {
    const Sample_T<NativeType>* const other_same_kind =
      dynamic_cast<const Sample_T<NativeType>*>(&other);
    OPENDDS_ASSERT(other_same_kind);
    return typename TraitsType::LessThanType()(*data_, *other_same_kind->data_);
  }

copy()

template<typename NativeType>

Sample_rch OpenDDS::DCPS::Sample_T< NativeType >::copy ( Mutability  mutability, Extent  extent  ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 229 of file Sample.h.

References OpenDDS::DCPS::dynamic_rchandle_cast().

  {
    NativeType* new_data = new NativeType;
    *new_data = *data_;
    return dynamic_rchandle_cast<Sample>(mutability == ReadOnly ?
      make_rch<Sample_T<NativeType> >(const_cast<const NativeType*>(new_data), extent) :
      make_rch<Sample_T<NativeType> >(new_data, extent));
  }

data()

template<typename NativeType>

const NativeType& OpenDDS::DCPS::Sample_T< NativeType >::data ( void  ) const

inline

Definition at line 163 of file Sample.h.

  {
    return *data_;
  }

deserialize()

template<typename NativeType>

bool OpenDDS::DCPS::Sample_T< NativeType >::deserialize ( Serializer &  ser )

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 193 of file Sample.h.

  {
    if (key_only()) {
      return ser >> mutable_key_only_data();
    } else {
      return ser >> mutable_data();
    }
  }

eval()

template<typename NativeType>

bool OpenDDS::DCPS::Sample_T< NativeType >::eval ( FilterEvaluator &  evaluator, const DDS::StringSeq &  params  ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 259 of file Sample.h.

References OpenDDS::DCPS::FilterEvaluator::eval().

  {
    return evaluator.eval(*data_, params);
  }

from_message_block()

template<typename NativeType>

bool OpenDDS::DCPS::Sample_T< NativeType >::from_message_block ( const ACE_Message_Block &  mb )

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 224 of file Sample.h.

  {
    return MarshalTraitsType::from_message_block(mutable_data(), mb);
  }

get_dynamic_data()

template<typename NativeType>

DDS::DynamicData_var OpenDDS::DCPS::Sample_T< NativeType >::get_dynamic_data ( DDS::DynamicType_ptr  type ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 239 of file Sample.h.

  {
#  if OPENDDS_HAS_DYNAMIC_DATA_ADAPTER
    if (type && !dynamic_data_) {
      dynamic_data_ = new DynamicDataImpl(type, getMetaStruct<NativeType>(), *data_);
    }
    return dynamic_data_;
#  else
    ACE_UNUSED_ARG(type);
    return 0;
#  endif
  }

key_only_data()

template<typename NativeType>

KeyOnlyType OpenDDS::DCPS::Sample_T< NativeType >::key_only_data ( ) const

inline

Definition at line 174 of file Sample.h.

  {
    return KeyOnlyType(*data_);
  }

mutable_data()

template<typename NativeType>

NativeType& OpenDDS::DCPS::Sample_T< NativeType >::mutable_data ( ) const

inline

Definition at line 168 of file Sample.h.

References OPENDDS_ASSERT.

  {
    OPENDDS_ASSERT(!read_only());
    return *const_cast<NativeType*>(data_);
  }

mutable_key_only_data()

template<typename NativeType>

MutableKeyOnlyType OpenDDS::DCPS::Sample_T< NativeType >::mutable_key_only_data ( ) const

inline

Definition at line 179 of file Sample.h.

  {
    return MutableKeyOnlyType(mutable_data());
  }

native_data()

template<typename NativeType>

const void* OpenDDS::DCPS::Sample_T< NativeType >::native_data ( ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 253 of file Sample.h.

  {
    return data_;
  }

serialize()

template<typename NativeType>

bool OpenDDS::DCPS::Sample_T< NativeType >::serialize ( Serializer &  ser ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 184 of file Sample.h.

  {
    if (key_only()) {
      return ser << key_only_data();
    } else {
      return ser << data();
    }
  }

serialized_size()

template<typename NativeType>

size_t OpenDDS::DCPS::Sample_T< NativeType >::serialized_size ( const Encoding &  enc ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 202 of file Sample.h.

References OpenDDS::DCPS::serialized_size().

  {
    if (key_only()) {
      return OpenDDS::DCPS::serialized_size(enc, key_only_data());
    } else {
      return OpenDDS::DCPS::serialized_size(enc, data());
    }
  }

to_message_block()

template<typename NativeType>

bool OpenDDS::DCPS::Sample_T< NativeType >::to_message_block ( ACE_Message_Block &  mb ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 219 of file Sample.h.

  {
    return MarshalTraitsType::to_message_block(mb, data());
  }

Member Data Documentation

data_

template<typename NativeType>

const NativeType* OpenDDS::DCPS::Sample_T< NativeType >::data_

private

Definition at line 267 of file Sample.h.

Referenced by OpenDDS::DCPS::Sample_T< NativeType >::compare().

dynamic_data_

template<typename NativeType>

DDS::DynamicData_var OpenDDS::DCPS::Sample_T< NativeType >::dynamic_data_

mutableprivate

Definition at line 269 of file Sample.h.

owns_data_

template<typename NativeType>

const bool OpenDDS::DCPS::Sample_T< NativeType >::owns_data_

private

Definition at line 266 of file Sample.h.

---

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

• Sample.h