OpenDDS::XTypes::DynamicSample Class Reference

#include <DynamicSample.h>

Inheritance diagram for OpenDDS::XTypes::DynamicSample:

Collaboration diagram for OpenDDS::XTypes::DynamicSample:

Classes
struct	KeyLessThan

Public Member Functions
	DynamicSample ()
	DynamicSample (const DynamicSample &)
DynamicSample &	operator= (const DynamicSample &)
	DynamicSample (DDS::DynamicData_ptr data, Mutability mutability, Extent extent)
	DynamicSample (DDS::DynamicData_ptr data, Extent extent)
	DynamicSample (DDS::DynamicData_ptr data)
void	set_key_only (bool k)
bool	serialize (DCPS::Serializer &ser) const
bool	deserialize (DCPS::Serializer &ser)
size_t	serialized_size (const DCPS::Encoding &enc) const
bool	compare (const DCPS::Sample &other) const
bool	to_message_block (ACE_Message_Block &) const
bool	from_message_block (const ACE_Message_Block &)
DCPS::Sample_rch	copy (DCPS::Sample::Mutability mutability, DCPS::Sample::Extent extent) const
DDS::DynamicData_var	get_dynamic_data (DDS::DynamicType_ptr) const
DDS::DynamicData_var	dynamic_data () const
const void *	native_data () const
bool	eval (DCPS::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

Protected Attributes
DDS::DynamicData_var	data_
Protected Attributes inherited from OpenDDS::DCPS::Sample
Mutability	mutability_
Extent	extent_

Additional Inherited Members
Public Types inherited from OpenDDS::DCPS::Sample
enum	Mutability { Mutable, ReadOnly }
enum	Extent { Full, KeyOnly, NestedKeyOnly }
Protected Member Functions inherited from OpenDDS::DCPS::RcObject
	RcObject ()

Detailed Description

Definition at line 17 of file DynamicSample.h.

Constructor & Destructor Documentation

DynamicSample() [1/5]

OpenDDS::XTypes::DynamicSample::DynamicSample

(

)

Definition at line 25 of file DynamicSample.cpp.

{}

DynamicSample() [2/5]

OpenDDS::XTypes::DynamicSample::DynamicSample

(

const DynamicSample &

d

)

Definition at line 28 of file DynamicSample.cpp.

  : Sample(d.mutability_, d.extent_)
  , data_(d.data_)
{}

DynamicSample() [3/5]

OpenDDS::XTypes::DynamicSample::DynamicSample ( DDS::DynamicData_ptr  data, Mutability  mutability, Extent  extent  )

inline

Definition at line 23 of file DynamicSample.h.

References _duplicate().

    : Sample(mutability, extent)
    , data_(DDS::DynamicData::_duplicate(data))
  {
  }

DynamicSample() [4/5]

OpenDDS::XTypes::DynamicSample::DynamicSample ( DDS::DynamicData_ptr  data, Extent  extent  )

inline

Definition at line 30 of file DynamicSample.h.

References _duplicate().

    : Sample(Sample::ReadOnly, extent)
    , data_(DDS::DynamicData::_duplicate(data))
  {
  }

DynamicSample() [5/5]

OpenDDS::XTypes::DynamicSample::DynamicSample ( DDS::DynamicData_ptr  data )

inline

Definition at line 36 of file DynamicSample.h.

References _duplicate().

    : Sample(Sample::ReadOnly, Sample::Full)
    , data_(DDS::DynamicData::_duplicate(data))
  {
  }

Member Function Documentation

compare()

bool OpenDDS::XTypes::DynamicSample::compare ( const DCPS::Sample &  other ) const

virtual

Implements OpenDDS::DCPS::Sample.

Definition at line 96 of file DynamicSample.cpp.

References ACE_ERROR, data_, OpenDDS::XTypes::key_less_than(), LM_WARNING, OpenDDS::DCPS::log_level, OPENDDS_ASSERT, OPENDDS_END_VERSIONED_NAMESPACE_DECL, DDS::RETCODE_OK, OpenDDS::DCPS::retcode_to_string(), and OpenDDS::DCPS::LogLevel::Warning.

Referenced by OpenDDS::XTypes::DynamicSample::KeyLessThan::operator()().

{
  const DynamicSample* const other_same_kind = dynamic_cast<const DynamicSample*>(&other);
  OPENDDS_ASSERT(other_same_kind);
  bool is_less_than = false;
  DDS::ReturnCode_t rc = key_less_than(is_less_than, data_, other_same_kind->data_);
  if (rc != DDS::RETCODE_OK) {
    if (log_level >= LogLevel::Warning) {
      ACE_ERROR((LM_WARNING, "(%P|%t) WARNING: DynamicSample::compare: "
        "key_less_than returned %C\n", retcode_to_string(rc)));
    }
  }
  return is_less_than;
}

copy()

DCPS::Sample_rch OpenDDS::XTypes::DynamicSample::copy ( DCPS::Sample::Mutability  mutability, DCPS::Sample::Extent  extent  ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 63 of file DynamicSample.h.

  {
    DDS::DynamicData_var dd = data_->clone();
    return DCPS::make_rch<DynamicSample>(dd, mutability, extent);
  }

deserialize()

bool OpenDDS::XTypes::DynamicSample::deserialize ( DCPS::Serializer &  ser )

virtual

Implements OpenDDS::DCPS::Sample.

Definition at line 73 of file DynamicSample.cpp.

References ACE_DEFAULT_MESSAGE_BLOCK_PRIORITY, data_, OpenDDS::DCPS::Serializer::encoding(), OpenDDS::DCPS::Sample::extent_, ACE_Allocator::instance(), OpenDDS::DCPS::Serializer::length(), ACE_Allocator::malloc(), ACE_Time_Value::max_time, ACE_Message_Block::MB_DATA, OpenDDS::DCPS::Serializer::read_octet_array(), ACE_Message_Block::wr_ptr(), and ACE_Time_Value::zero.

Referenced by OpenDDS::DCPS::operator>>().

{
  // DynamicDataXcdrReadImpl uses a message block to read the data on demand,
  // but it can't be the same message block that 'ser' already has.  That one
  // (or more than one if there's chaining) uses the allocators and locking
  // strategy from the transport.
  const ACE_CDR::ULong len = static_cast<ACE_CDR::ULong>(ser.length());
  ACE_Allocator* const alloc = ACE_Allocator::instance();
  const Message_Block_Ptr mb(new(alloc->malloc(sizeof(ACE_Message_Block)))
    ACE_Message_Block(len, ACE_Message_Block::MB_DATA, 0, 0, alloc, 0,
      ACE_DEFAULT_MESSAGE_BLOCK_PRIORITY, ACE_Time_Value::zero,
      ACE_Time_Value::max_time, alloc, alloc));
  unsigned char* const out = reinterpret_cast<unsigned char*>(mb->wr_ptr());
  if (!ser.read_octet_array(out, len)) {
    return false;
  }
  mb->wr_ptr(len);

  const DDS::DynamicType_var type = data_->type();
  data_ = new DynamicDataXcdrReadImpl(mb.get(), ser.encoding(), type, extent_);
  return true;
}

dynamic_data()

DDS::DynamicData_var OpenDDS::XTypes::DynamicSample::dynamic_data ( ) const

inline

Definition at line 74 of file DynamicSample.h.

Referenced by OpenDDS::XTypes::DynamicSequenceAdapter::assign_sample(), OpenDDS::DCPS::DynamicComparator::cmp(), OpenDDS::DCPS::NestedComparator::get_nested(), and OpenDDS::DCPS::MetaStructImpl< XTypes::DynamicSample >::getValue().

  {
    return data_;
  }

eval()

bool OpenDDS::XTypes::DynamicSample::eval ( DCPS::FilterEvaluator &  evaluator, const DDS::StringSeq &  params  ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 85 of file DynamicSample.h.

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

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

from_message_block()

bool OpenDDS::XTypes::DynamicSample::from_message_block ( const ACE_Message_Block &  )

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 56 of file DynamicSample.h.

References OPENDDS_ASSERT.

  {
    // Not needed
    OPENDDS_ASSERT(false);
    return false;
  }

get_dynamic_data()

DDS::DynamicData_var OpenDDS::XTypes::DynamicSample::get_dynamic_data ( DDS::DynamicType_ptr  ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 69 of file DynamicSample.h.

Referenced by OpenDDS::XTypes::DynamicDataReaderImpl::get_key_value(), OpenDDS::XTypes::DynamicDataReaderImpl::read_next_sample(), and OpenDDS::XTypes::DynamicDataReaderImpl::take_next_sample().

  {
    return data_;
  }

native_data()

const void* OpenDDS::XTypes::DynamicSample::native_data ( ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 79 of file DynamicSample.h.

  {
    return 0;
  }

operator=()

DynamicSample & OpenDDS::XTypes::DynamicSample::operator=

(

const DynamicSample &

rhs

)

Definition at line 33 of file DynamicSample.cpp.

References data_, OpenDDS::DCPS::Sample::extent_, and OpenDDS::DCPS::Sample::mutability_.

{
  if (this != &rhs) {
    mutability_ = rhs.mutability_;
    extent_ = rhs.extent_;
    data_ = rhs.data_;
  }
  return *this;
}

serialize()

bool OpenDDS::XTypes::DynamicSample::serialize ( DCPS::Serializer &  ser ) const

virtual

Implements OpenDDS::DCPS::Sample.

Definition at line 58 of file DynamicSample.cpp.

References ACE_ERROR, data_, OpenDDS::DCPS::Sample::key_only(), LM_NOTICE, OpenDDS::DCPS::log_level, and OpenDDS::DCPS::LogLevel::Notice.

{
  const DynamicDataImpl* const ddi = dynamic_cast<DynamicDataImpl*>(data_.in());
  if (!ddi) {
    if (log_level >= LogLevel::Notice) {
      ACE_ERROR((LM_NOTICE, "(%P|%t) NOTICE: DynamicSample::serialize: "
        "DynamicData must be DynamicDataImpl, the type supplied by DynamicDataFactory\n"));
    }
    return false;
  }
  return key_only()
    ? ser << DCPS::KeyOnly<const DynamicDataImpl>(*ddi)
    : ser << *ddi;
}

serialized_size()

size_t OpenDDS::XTypes::DynamicSample::serialized_size ( const DCPS::Encoding &  enc ) const

virtual

Implements OpenDDS::DCPS::Sample.

Definition at line 43 of file DynamicSample.cpp.

References ACE_ERROR, data_, OpenDDS::DCPS::Sample::key_only(), LM_WARNING, OpenDDS::DCPS::log_level, OpenDDS::DCPS::serialized_size(), and OpenDDS::DCPS::LogLevel::Warning.

{
  const DynamicDataImpl* const ddi = dynamic_cast<DynamicDataImpl*>(data_.in());
  if (!ddi) {
    if (log_level >= LogLevel::Warning) {
      ACE_ERROR((LM_WARNING, "(%P|%t) WARNING: DynamicSample::serialized_size: "
        "DynamicData must be DynamicDataImpl, the type supplied by DynamicDataFactory\n"));
    }
    return 0;
  }
  return key_only()
    ? DCPS::serialized_size(enc, DCPS::KeyOnly<const DynamicDataImpl>(*ddi))
    : DCPS::serialized_size(enc, *ddi);
}

set_key_only()

void OpenDDS::XTypes::DynamicSample::set_key_only ( bool  k )

inline

Definition at line 42 of file DynamicSample.h.

References OpenDDS::DCPS::Sample::Full, OpenDDS::DCPS::Sample::KeyOnly, and OpenDDS::DCPS::serialized_size().

{ extent_ = k ? Sample::KeyOnly : Sample::Full; }

to_message_block()

bool OpenDDS::XTypes::DynamicSample::to_message_block ( ACE_Message_Block &  ) const

inlinevirtual

Implements OpenDDS::DCPS::Sample.

Definition at line 49 of file DynamicSample.h.

References OPENDDS_ASSERT.

  {
    // Not needed
    OPENDDS_ASSERT(false);
    return false;
  }

Member Data Documentation

data_

DDS::DynamicData_var OpenDDS::XTypes::DynamicSample::data_

protected

Definition at line 99 of file DynamicSample.h.

Referenced by compare(), deserialize(), operator=(), serialize(), and serialized_size().

---

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

• DynamicSample.h
• DynamicSample.cpp