OpenDDS::DCPS::ValueWriter Class Reference

#include <ValueWriter.h>

Inheritance diagram for OpenDDS::DCPS::ValueWriter:

Public Member Functions
	ValueWriter ()
virtual	~ValueWriter ()
virtual void	begin_struct ()
virtual void	end_struct ()
virtual void	begin_struct_member (const DDS::MemberDescriptor &)
virtual void	end_struct_member ()
virtual void	begin_union ()
virtual void	end_union ()
virtual void	begin_discriminator ()
virtual void	end_discriminator ()
virtual void	begin_union_member (const char *)
virtual void	end_union_member ()
virtual void	begin_array ()
virtual void	end_array ()
virtual void	begin_sequence ()
virtual void	end_sequence ()
virtual void	begin_element (size_t)
virtual void	end_element ()
virtual void	write_boolean (ACE_CDR::Boolean)=0
virtual void	write_byte (ACE_CDR::Octet)=0
virtual void	write_int16 (ACE_CDR::Short)=0
virtual void	write_uint16 (ACE_CDR::UShort)=0
virtual void	write_int32 (ACE_CDR::Long)=0
virtual void	write_uint32 (ACE_CDR::ULong)=0
virtual void	write_int64 (ACE_CDR::LongLong)=0
virtual void	write_uint64 (ACE_CDR::ULongLong)=0
virtual void	write_float32 (ACE_CDR::Float)=0
virtual void	write_float64 (ACE_CDR::Double)=0
virtual void	write_float128 (ACE_CDR::LongDouble)=0
virtual void	write_fixed (const OpenDDS::FaceTypes::Fixed &)=0
virtual void	write_char8 (ACE_CDR::Char)=0
virtual void	write_char16 (ACE_CDR::WChar)=0
virtual void	write_string (const ACE_CDR::Char *, size_t)=0
void	write_string (const ACE_CDR::Char *value)
void	write_string (const std::string &value)
virtual void	write_wstring (const ACE_CDR::WChar *, size_t)=0
void	write_wstring (const ACE_CDR::WChar *value)
void	write_wstring (const std::wstring &value)
virtual void	write_enum (const char *, ACE_CDR::Long)=0
template<typename T >
void	write_enum (const char *name, const T &value)
virtual void	write_boolean_array (const ACE_CDR::Boolean *x, size_t length)
virtual void	write_byte_array (const ACE_CDR::Octet *x, size_t length)
virtual void	write_int16_array (const ACE_CDR::Short *x, size_t length)
virtual void	write_uint16_array (const ACE_CDR::UShort *x, size_t length)
virtual void	write_int32_array (const ACE_CDR::Long *x, size_t length)
virtual void	write_uint32_array (const ACE_CDR::ULong *x, size_t length)
virtual void	write_int64_array (const ACE_CDR::LongLong *x, size_t length)
virtual void	write_uint64_array (const ACE_CDR::ULongLong *x, size_t length)
virtual void	write_float32_array (const ACE_CDR::Float *x, size_t length)
virtual void	write_float64_array (const ACE_CDR::Double *x, size_t length)
virtual void	write_float128_array (const ACE_CDR::LongDouble *x, size_t length)
virtual void	write_char8_array (const ACE_CDR::Char *x, size_t length)
virtual void	write_char16_array (const ACE_CDR::WChar *x, size_t length)

Detailed Description

A ValueWriter receives events and values from the recitation of a value. Typical examples of value recitation are serializing an object for transmission, formatting an object for printing, or copying an object to another representation, e.g., C++ to v8. To use it, one manually or automatically, e.g., code generation in the IDL compiler, defines a vwrite function for a given type V.

void vwrite(ValueWriter& vw, const V& value)

The vwrite function should invoke the appropriate methods of the ValueWriter and dispatch for other vwrite functions.

Definition at line 38 of file ValueWriter.h.

Constructor & Destructor Documentation

ValueWriter()

OpenDDS::DCPS::ValueWriter::ValueWriter ( )

inline

Definition at line 40 of file ValueWriter.h.

{}

~ValueWriter()

virtual OpenDDS::DCPS::ValueWriter::~ValueWriter ( )

inlinevirtual

Definition at line 41 of file ValueWriter.h.

{}

Member Function Documentation

begin_array()

virtual void OpenDDS::DCPS::ValueWriter::begin_array ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 55 of file ValueWriter.h.

{}

begin_discriminator()

virtual void OpenDDS::DCPS::ValueWriter::begin_discriminator ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 50 of file ValueWriter.h.

{}

begin_element()

virtual void OpenDDS::DCPS::ValueWriter::begin_element ( size_t  )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 59 of file ValueWriter.h.

Referenced by write_boolean_array(), write_byte_array(), write_char16_array(), write_char8_array(), write_float128_array(), write_float32_array(), write_float64_array(), write_int16_array(), write_int32_array(), write_int64_array(), write_uint16_array(), write_uint32_array(), and write_uint64_array().

{}

begin_sequence()

virtual void OpenDDS::DCPS::ValueWriter::begin_sequence ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 57 of file ValueWriter.h.

{}

begin_struct()

virtual void OpenDDS::DCPS::ValueWriter::begin_struct ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 43 of file ValueWriter.h.

Referenced by OpenDDS::DCPS::vwrite().

{}

begin_struct_member()

virtual void OpenDDS::DCPS::ValueWriter::begin_struct_member ( const DDS::MemberDescriptor &  )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 45 of file ValueWriter.h.

Referenced by OpenDDS::DCPS::vwrite().

{}

begin_union()

virtual void OpenDDS::DCPS::ValueWriter::begin_union ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 48 of file ValueWriter.h.

{}

begin_union_member()

virtual void OpenDDS::DCPS::ValueWriter::begin_union_member ( const char *  )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 52 of file ValueWriter.h.

{}

end_array()

virtual void OpenDDS::DCPS::ValueWriter::end_array ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 56 of file ValueWriter.h.

{}

end_discriminator()

virtual void OpenDDS::DCPS::ValueWriter::end_discriminator ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 51 of file ValueWriter.h.

{}

end_element()

virtual void OpenDDS::DCPS::ValueWriter::end_element ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 60 of file ValueWriter.h.

References value.

Referenced by write_boolean_array(), write_byte_array(), write_char16_array(), write_char8_array(), write_float128_array(), write_float32_array(), write_float64_array(), write_int16_array(), write_int32_array(), write_int64_array(), write_uint16_array(), write_uint32_array(), and write_uint64_array().

{}

end_sequence()

virtual void OpenDDS::DCPS::ValueWriter::end_sequence ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 58 of file ValueWriter.h.

{}

end_struct()

virtual void OpenDDS::DCPS::ValueWriter::end_struct ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 44 of file ValueWriter.h.

Referenced by OpenDDS::DCPS::vwrite().

{}

end_struct_member()

virtual void OpenDDS::DCPS::ValueWriter::end_struct_member ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 46 of file ValueWriter.h.

Referenced by OpenDDS::DCPS::vwrite().

{}

end_union()

virtual void OpenDDS::DCPS::ValueWriter::end_union ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 49 of file ValueWriter.h.

{}

end_union_member()

virtual void OpenDDS::DCPS::ValueWriter::end_union_member ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::PrinterValueWriter.

Definition at line 53 of file ValueWriter.h.

{}

write_boolean()

virtual void OpenDDS::DCPS::ValueWriter::write_boolean ( ACE_CDR::Boolean  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by write_boolean_array().

write_boolean_array()

void OpenDDS::DCPS::ValueWriter::write_boolean_array ( const ACE_CDR::Boolean *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 26 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_boolean().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_boolean(x[i]);
    end_element();
  }
}

write_byte()

virtual void OpenDDS::DCPS::ValueWriter::write_byte ( ACE_CDR::Octet  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by write_byte_array().

write_byte_array()

void OpenDDS::DCPS::ValueWriter::write_byte_array ( const ACE_CDR::Octet *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 36 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_byte().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_byte(x[i]);
    end_element();
  }
}

write_char16()

virtual void OpenDDS::DCPS::ValueWriter::write_char16 ( ACE_CDR::WChar  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by write_char16_array().

write_char16_array()

void OpenDDS::DCPS::ValueWriter::write_char16_array ( const ACE_CDR::WChar *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 168 of file ValueWriter.cpp.

References begin_element(), end_element(), OPENDDS_END_VERSIONED_NAMESPACE_DECL, and write_char16().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_char16(x[i]);
    end_element();
  }
}

write_char8()

virtual void OpenDDS::DCPS::ValueWriter::write_char8 ( ACE_CDR::Char  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by write_char8_array().

write_char8_array()

void OpenDDS::DCPS::ValueWriter::write_char8_array ( const ACE_CDR::Char *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 158 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_char8().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_char8(x[i]);
    end_element();
  }
}

write_enum() [1/2]

virtual void OpenDDS::DCPS::ValueWriter::write_enum ( const char *  , ACE_CDR::Long    )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

write_enum() [2/2]

template<typename T >

void OpenDDS::DCPS::ValueWriter::write_enum ( const char *  name, const T &  value  )

inline

Definition at line 108 of file ValueWriter.h.

References OPENDDS_END_VERSIONED_NAMESPACE_DECL.

  {
    write_enum(name, static_cast<ACE_CDR::Long>(value));
  }

write_fixed()

virtual void OpenDDS::DCPS::ValueWriter::write_fixed ( const OpenDDS::FaceTypes::Fixed &  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

write_float128()

virtual void OpenDDS::DCPS::ValueWriter::write_float128 ( ACE_CDR::LongDouble  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by write_float128_array().

write_float128_array()

void OpenDDS::DCPS::ValueWriter::write_float128_array ( const ACE_CDR::LongDouble *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 148 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_float128().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_float128(x[i]);
    end_element();
  }
}

write_float32()

virtual void OpenDDS::DCPS::ValueWriter::write_float32 ( ACE_CDR::Float  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by write_float32_array().

write_float32_array()

void OpenDDS::DCPS::ValueWriter::write_float32_array ( const ACE_CDR::Float *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 128 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_float32().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_float32(x[i]);
    end_element();
  }
}

write_float64()

virtual void OpenDDS::DCPS::ValueWriter::write_float64 ( ACE_CDR::Double  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by write_float64_array().

write_float64_array()

void OpenDDS::DCPS::ValueWriter::write_float64_array ( const ACE_CDR::Double *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 138 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_float64().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_float64(x[i]);
    end_element();
  }
}

write_int16()

virtual void OpenDDS::DCPS::ValueWriter::write_int16 ( ACE_CDR::Short  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by write_int16_array().

write_int16_array()

void OpenDDS::DCPS::ValueWriter::write_int16_array ( const ACE_CDR::Short *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 68 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_int16().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_int16(x[i]);
    end_element();
  }
}

write_int32()

virtual void OpenDDS::DCPS::ValueWriter::write_int32 ( ACE_CDR::Long  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by OpenDDS::DCPS::vwrite(), and write_int32_array().

write_int32_array()

void OpenDDS::DCPS::ValueWriter::write_int32_array ( const ACE_CDR::Long *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 88 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_int32().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_int32(x[i]);
    end_element();
  }
}

write_int64()

virtual void OpenDDS::DCPS::ValueWriter::write_int64 ( ACE_CDR::LongLong  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by OpenDDS::DCPS::vwrite(), and write_int64_array().

write_int64_array()

void OpenDDS::DCPS::ValueWriter::write_int64_array ( const ACE_CDR::LongLong *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 108 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_int64().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_int64(x[i]);
    end_element();
  }
}

write_string() [1/3]

virtual void OpenDDS::DCPS::ValueWriter::write_string ( const ACE_CDR::Char *  , size_t    )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

write_string() [2/3]

void OpenDDS::DCPS::ValueWriter::write_string ( const ACE_CDR::Char *  value )

inline

Definition at line 86 of file ValueWriter.h.

References write_string().

Referenced by write_string().

{ write_string(value, std::strlen(value)); }

write_string() [3/3]

void OpenDDS::DCPS::ValueWriter::write_string ( const std::string &  value )

inline

Definition at line 87 of file ValueWriter.h.

References write_string().

Referenced by write_string().

{ write_string(value.c_str(), value.length()); }

write_uint16()

virtual void OpenDDS::DCPS::ValueWriter::write_uint16 ( ACE_CDR::UShort  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by write_uint16_array().

write_uint16_array()

void OpenDDS::DCPS::ValueWriter::write_uint16_array ( const ACE_CDR::UShort *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 78 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_uint16().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_uint16(x[i]);
    end_element();
  }
}

write_uint32()

virtual void OpenDDS::DCPS::ValueWriter::write_uint32 ( ACE_CDR::ULong  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by OpenDDS::DCPS::vwrite(), and write_uint32_array().

write_uint32_array()

void OpenDDS::DCPS::ValueWriter::write_uint32_array ( const ACE_CDR::ULong *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 98 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_uint32().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_uint32(x[i]);
    end_element();
  }
}

write_uint64()

virtual void OpenDDS::DCPS::ValueWriter::write_uint64 ( ACE_CDR::ULongLong  )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

Referenced by write_uint64_array().

write_uint64_array()

void OpenDDS::DCPS::ValueWriter::write_uint64_array ( const ACE_CDR::ULongLong *  x, size_t  length  )

virtual

Array write operations Note: the portion written starts at x and ends at x + length.

Definition at line 118 of file ValueWriter.cpp.

References begin_element(), end_element(), and write_uint64().

{
  for (size_t i = 0; i != length; ++i) {
    begin_element(i);
    write_uint64(x[i]);
    end_element();
  }
}

write_wstring() [1/3]

virtual void OpenDDS::DCPS::ValueWriter::write_wstring ( const ACE_CDR::WChar *  , size_t    )

pure virtual

Implemented in OpenDDS::DCPS::PrinterValueWriter.

write_wstring() [2/3]

void OpenDDS::DCPS::ValueWriter::write_wstring ( const ACE_CDR::WChar *  value )

inline

Definition at line 89 of file ValueWriter.h.

  {
#ifdef DDS_HAS_WCHAR
    write_wstring(value, std::wcslen(value));
#else
    ACE_UNUSED_ARG(value);
#endif
  }

write_wstring() [3/3]

void OpenDDS::DCPS::ValueWriter::write_wstring ( const std::wstring &  value )

inline

Definition at line 97 of file ValueWriter.h.

  {
#ifdef DDS_HAS_WCHAR
    write_wstring(value.c_str(), value.length());
#else
    ACE_UNUSED_ARG(value);
#endif
  }

---

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

• ValueWriter.h
• ValueWriter.cpp