OpenDDS::DCPS::Sample Class Reference

#include <Sample.h>

Inheritance diagram for OpenDDS::DCPS::Sample:

Collaboration diagram for OpenDDS::DCPS::Sample:

Public Types
enum	Mutability { Mutable, ReadOnly }
enum	Extent { Full, KeyOnly, NestedKeyOnly }

Public Member Functions
	Sample ()
	Sample (Mutability mutability, Extent extent)
virtual	~Sample ()
bool	read_only () const
bool	key_only () const
virtual bool	serialize (Serializer &ser) const =0
virtual bool	deserialize (Serializer &ser)=0
virtual size_t	serialized_size (const Encoding &enc) const =0
virtual bool	compare (const Sample &other) const =0
virtual bool	to_message_block (ACE_Message_Block &mb) const =0
virtual bool	from_message_block (const ACE_Message_Block &mb)=0
virtual Sample_rch	copy (Mutability mutability, Extent extent) const =0
Sample_rch	copy (Mutability mutability) const
virtual DDS::DynamicData_var	get_dynamic_data (DDS::DynamicType_ptr type) const =0
virtual const void *	native_data () const =0
virtual bool	eval (FilterEvaluator &evaluator, const DDS::StringSeq &params) const =0
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
Mutability	mutability_
Extent	extent_

Additional Inherited Members
Protected Member Functions inherited from OpenDDS::DCPS::RcObject
	RcObject ()

Detailed Description

Represents a sample that can either be an instance of a C++ generated type from opendds_idl or a DynamicData. This is meant to be used by DataReaderImpl and DataWriterImpl.

Definition at line 31 of file Sample.h.

Member Enumeration Documentation

Extent

enum OpenDDS::DCPS::Sample::Extent

Enumerator
Full
KeyOnly
NestedKeyOnly

Definition at line 38 of file Sample.h.

              {
    Full,
    KeyOnly,
    NestedKeyOnly
  };

Mutability

enum OpenDDS::DCPS::Sample::Mutability

Enumerator
Mutable
ReadOnly

Definition at line 33 of file Sample.h.

                  {
    Mutable,
    ReadOnly
  };

Constructor & Destructor Documentation

Sample() [1/2]

OpenDDS::DCPS::Sample::Sample ( )

inline

Definition at line 44 of file Sample.h.

    : mutability_(Mutable)
    , extent_(Full)
  {
  }

Sample() [2/2]

OpenDDS::DCPS::Sample::Sample ( Mutability  mutability, Extent  extent  )

inline

Definition at line 50 of file Sample.h.

References OPENDDS_ASSERT.

    : mutability_(mutability)
    , extent_(extent)
  {
    OPENDDS_ASSERT(extent != NestedKeyOnly);
  }

~Sample()

virtual OpenDDS::DCPS::Sample::~Sample ( )

inlinevirtual

Definition at line 57 of file Sample.h.

{}

Member Function Documentation

compare()

virtual bool OpenDDS::DCPS::Sample::compare ( const Sample &  other ) const

pure virtual

Implemented in OpenDDS::DCPS::Sample_T< NativeType >, and OpenDDS::XTypes::DynamicSample.

copy() [1/2]

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

pure virtual

Implemented in OpenDDS::DCPS::Sample_T< NativeType >, and OpenDDS::XTypes::DynamicSample.

Referenced by OpenDDS::DCPS::DataWriterImpl::get_or_create_instance_handle().

copy() [2/2]

Sample_rch OpenDDS::DCPS::Sample::copy ( Mutability  mutability ) const

inline

Definition at line 77 of file Sample.h.

References copy().

  {
    return copy(mutability, extent_);
  }

deserialize()

virtual bool OpenDDS::DCPS::Sample::deserialize ( Serializer &  ser )

pure virtual

Implemented in OpenDDS::DCPS::Sample_T< NativeType >, and OpenDDS::XTypes::DynamicSample.

eval()

virtual bool OpenDDS::DCPS::Sample::eval ( FilterEvaluator &  evaluator, const DDS::StringSeq &  params  ) const

pure virtual

Implemented in OpenDDS::DCPS::Sample_T< NativeType >, and OpenDDS::XTypes::DynamicSample.

Referenced by OpenDDS::DCPS::DataWriterImpl::write_w_timestamp().

from_message_block()

virtual bool OpenDDS::DCPS::Sample::from_message_block ( const ACE_Message_Block &  mb )

pure virtual

Implemented in OpenDDS::DCPS::Sample_T< NativeType >, and OpenDDS::XTypes::DynamicSample.

get_dynamic_data()

virtual DDS::DynamicData_var OpenDDS::DCPS::Sample::get_dynamic_data ( DDS::DynamicType_ptr  type ) const

pure virtual

Implemented in OpenDDS::DCPS::Sample_T< NativeType >, and OpenDDS::XTypes::DynamicSample.

Referenced by OpenDDS::DCPS::DataWriterImpl::dispose_w_timestamp().

key_only()

bool OpenDDS::DCPS::Sample::key_only ( ) const

inline

Definition at line 64 of file Sample.h.

References copy(), and OpenDDS::DCPS::serialized_size().

Referenced by OpenDDS::DCPS::DataWriterImpl::EncodingMode::buffer_size(), OpenDDS::DCPS::DataWriterImpl::instance_must_exist(), OpenDDS::XTypes::DynamicSample::serialize(), OpenDDS::DCPS::DataWriterImpl::serialize_sample(), and OpenDDS::XTypes::DynamicSample::serialized_size().

  {
    return extent_ == KeyOnly;
  }

native_data()

virtual const void* OpenDDS::DCPS::Sample::native_data ( ) const

pure virtual

Implemented in OpenDDS::DCPS::Sample_T< NativeType >, and OpenDDS::XTypes::DynamicSample.

Referenced by OpenDDS::DCPS::DataWriterImpl::write_sample().

read_only()

bool OpenDDS::DCPS::Sample::read_only ( ) const

inline

Definition at line 59 of file Sample.h.

  {
    return mutability_ == ReadOnly;
  }

serialize()

virtual bool OpenDDS::DCPS::Sample::serialize ( Serializer &  ser ) const

pure virtual

Implemented in OpenDDS::DCPS::Sample_T< NativeType >, and OpenDDS::XTypes::DynamicSample.

Referenced by OpenDDS::DCPS::DataWriterImpl::serialize_sample().

serialized_size()

virtual size_t OpenDDS::DCPS::Sample::serialized_size ( const Encoding &  enc ) const

pure virtual

Implemented in OpenDDS::DCPS::Sample_T< NativeType >, and OpenDDS::XTypes::DynamicSample.

Referenced by OpenDDS::DCPS::DataWriterImpl::EncodingMode::buffer_size().

to_message_block()

virtual bool OpenDDS::DCPS::Sample::to_message_block ( ACE_Message_Block &  mb ) const

pure virtual

Implemented in OpenDDS::DCPS::Sample_T< NativeType >, and OpenDDS::XTypes::DynamicSample.

Referenced by OpenDDS::DCPS::DataWriterImpl::serialize_sample().

Member Data Documentation

extent_

Extent OpenDDS::DCPS::Sample::extent_

protected

Definition at line 94 of file Sample.h.

Referenced by OpenDDS::XTypes::DynamicSample::deserialize(), and OpenDDS::XTypes::DynamicSample::operator=().

mutability_

Mutability OpenDDS::DCPS::Sample::mutability_

protected

Definition at line 93 of file Sample.h.

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

---

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

• Sample.h