OpenDDS::DataRepresentationAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for OpenDDS::DataRepresentationAnnotation:

Collaboration diagram for OpenDDS::DataRepresentationAnnotation:

Public Member Functions
std::string	definition () const
std::string	name () const
std::string	module () const
bool	node_value_exists (AST_Decl *node, DataRepresentation &value) const
Public Member Functions inherited from AnnotationWithValue< DataRepresentation >
virtual bool	node_value_exists (AST_Decl *node, DataRepresentation &value) const
Public Member Functions inherited from Annotation
	Annotation ()
virtual	~Annotation ()
virtual std::string	fullname () const
AST_Annotation_Decl *	declaration () const
AST_Annotation_Appl *	find_on (AST_Decl *node) const
void	cache ()

Protected Member Functions
DataRepresentation	value_from_appl (AST_Annotation_Appl *appl) const

Detailed Description

Used to specify the allowed RTPS data representations in XTypes. Replacement for ::data_representation which requires bitmask.

Definition at line 406 of file annotations.h.

Member Function Documentation

definition()

std::string OpenDDS::DataRepresentationAnnotation::definition ( ) const

virtual

Implements Annotation.

Definition at line 437 of file annotations.cpp.

  {
    return
      "module OpenDDS {\n"
      "  @annotation data_representation {\n"
      "    enum Kind_t {\n"
      "      XCDR1,\n"
      "      XML,\n"
      "      XCDR2,\n"
      "      UNALIGNED_CDR\n"
      "    };\n"
      "    Kind_t kind;\n"
      "  };\n"
      "};\n";
  }

module()

std::string OpenDDS::DataRepresentationAnnotation::module ( void  ) const

virtual

Reimplemented from Annotation.

Definition at line 498 of file annotations.cpp.

References OPENDDS_END_VERSIONED_NAMESPACE_DECL.

  {
    return "::OpenDDS::";
  }

name()

std::string OpenDDS::DataRepresentationAnnotation::name ( void  ) const

virtual

Implements Annotation.

Definition at line 453 of file annotations.cpp.

  {
    return "data_representation";
  }

node_value_exists()

bool OpenDDS::DataRepresentationAnnotation::node_value_exists	(	AST_Decl *	node,
		DataRepresentation &	value
	)		const

Definition at line 458 of file annotations.cpp.

References OpenDDS::DataRepresentation::add(), and Annotation::declaration().

Referenced by invalid_option().

  {
    value = DataRepresentation();
    bool found = false;
    if (node) {
      for (AST_Annotation_Appls::iterator i = node->annotations().begin();
          i != node->annotations().end(); ++i) {
        AST_Annotation_Appl* appl = i->get();
        if (appl && appl->annotation_decl() == declaration()) {
          found = true;
          value.add(value_from_appl(appl));
        }
      }
    }
    return found;
  }

value_from_appl()

DataRepresentation OpenDDS::DataRepresentationAnnotation::value_from_appl ( AST_Annotation_Appl *  appl ) const

protectedvirtual

Reimplemented from AnnotationWithValue< DataRepresentation >.

Definition at line 476 of file annotations.cpp.

References Annotation::declaration(), get_u32_annotation_member_value(), OpenDDS::DataRepresentation::unaligned, value, OpenDDS::DataRepresentation::xcdr1, OpenDDS::DataRepresentation::xcdr2, and OpenDDS::DataRepresentation::xml.

  {
    DataRepresentation value;
    if (appl && appl->annotation_decl() == declaration()) {
      switch (get_u32_annotation_member_value(appl, "kind")) {
      case 0: // Kind_t::XCDR1
        value.xcdr1 = true;
        break;
      case 1: // Kind_t::XML
        value.xml = true;
        break;
      case 2: // Kind_t::XCDR2
        value.xcdr2 = true;
        break;
      case 3: // Kind_t::UNALIGNED_CDR
        value.unaligned = true;
        break;
      }
    }
    return value;
  }

---

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

• annotations.h
• annotations.cpp