TopicKeys Class Reference

#include <topic_keys.h>

Classes
class	Error
class	Iterator

Public Types
enum	RootType {   PrimitiveType, StructureType, ArrayType, UnionType,   SequenceType, InvalidType }

Public Member Functions
	TopicKeys ()
	TopicKeys (const TopicKeys &other)
	TopicKeys (AST_Structure *root, bool recursive=true)
	TopicKeys (AST_Union *root)
	~TopicKeys ()
TopicKeys &	operator= (const TopicKeys &other)
AST_Decl *	root () const
RootType	root_type () const
Iterator	begin ()
Iterator	end ()
size_t	count ()
bool	recursive () const

Static Public Member Functions
static RootType	root_type (AST_Type *type)

Private Attributes
AST_Decl *	root_
RootType	root_type_
bool	counted_
size_t	count_
bool	recursive_
	} More...

Detailed Description

Find Keys in Topic Types

Use like this: AST_Structure* struct_node; // ... TopicKeys keys(struct_node); TopicKeys::Iterator end = keys.end(); for (TopicKeys::Iterator i = keys.begin(); i != end; ++i) { AST_Decl* key = *i; // ... }

The key AST_Decl will be a different type of node depending on the key:

• For struct field keys this will be the AST_Field
• For Array keys this will be the base AST_Type, repeated for each element
• For Union keys this will be the AST_Union

Definition at line 34 of file topic_keys.h.

Member Enumeration Documentation

RootType

enum TopicKeys::RootType

Enumerator
PrimitiveType
StructureType
ArrayType
UnionType
SequenceType
InvalidType

Definition at line 36 of file topic_keys.h.

                {
    PrimitiveType,
    StructureType,
    ArrayType,
    UnionType,
    SequenceType,
    InvalidType
  };

Constructor & Destructor Documentation

TopicKeys() [1/4]

TopicKeys::TopicKeys

(

)

Definition at line 447 of file topic_keys.cpp.

  : root_(0),
    root_type_(InvalidType),
    counted_(false),
    count_(0),
    recursive_(false)
{
}

TopicKeys() [2/4]

TopicKeys::TopicKeys

(

const TopicKeys &

other

)

Definition at line 456 of file topic_keys.cpp.

{
  *this = other;
}

TopicKeys() [3/4]

TopicKeys::TopicKeys	(	AST_Structure *	root,
		bool	recursive = true
	)

If recursive is false, do a shallow iteration.

Definition at line 461 of file topic_keys.cpp.

References root(), and root_.

  : root_(root),
    root_type_(StructureType),
    counted_(false),
    count_(0),
    recursive_(recursive)
{
  root_ = root;
}

TopicKeys() [4/4]

TopicKeys::TopicKeys

(

AST_Union *

root

)

Definition at line 471 of file topic_keys.cpp.

References root(), and root_.

  : root_(root),
    root_type_(UnionType),
    counted_(false),
    count_(0),
    recursive_(false)
{
  root_ = root;
}

~TopicKeys()

TopicKeys::~TopicKeys

(

)

Definition at line 481 of file topic_keys.cpp.

{
}

Member Function Documentation

begin()

TopicKeys::Iterator TopicKeys::begin

(

void

)

Definition at line 495 of file topic_keys.cpp.

Referenced by count(), keys_generator::gen_struct(), marshal_generator::gen_typedef(), ts_generator::ts_generator(), and dds_visitor::visit_structure().

{
  return Iterator(*this);
}

count()

size_t TopicKeys::count

(

void

)

Count the keys in the topic type

Definition at line 515 of file topic_keys.cpp.

References begin(), count_, counted_, and end().

Referenced by metaclass_generator::gen_enum(), keys_generator::gen_struct(), marshal_generator::gen_typedef(), ts_generator::generate_ts(), and dds_visitor::visit_structure().

{
  if (!counted_) {
    count_ = 0;
    Iterator finished = end();
    for (Iterator i = begin(); i != finished; ++i) {
      count_++;
    }
    counted_ = true;
  }
  return count_;
}

end()

TopicKeys::Iterator TopicKeys::end

(

void

)

Definition at line 500 of file topic_keys.cpp.

References TopicKeys::Iterator::end_value().

Referenced by count(), TopicKeys::Iterator::end_value(), keys_generator::gen_struct(), marshal_generator::gen_typedef(), ts_generator::ts_generator(), and dds_visitor::visit_structure().

{
  return Iterator::end_value();
}

operator=()

TopicKeys & TopicKeys::operator=

(

const TopicKeys &

other

)

Definition at line 485 of file topic_keys.cpp.

References count_, counted_, recursive_, root_, and root_type_.

{
  root_ = other.root_;
  root_type_ = other.root_type_;
  counted_ = other.counted_;
  count_ = other.count_;
  recursive_ = other.recursive_;
  return *this;
}

recursive()

bool TopicKeys::recursive

(

)

const

Definition at line 528 of file topic_keys.cpp.

References recursive_.

{
  return recursive_;
}

root()

AST_Decl * TopicKeys::root

(

void

)

const

Definition at line 505 of file topic_keys.cpp.

References root_.

Referenced by TopicKeys::Iterator::Iterator(), and TopicKeys().

{
  return root_;
}

root_type() [1/2]

TopicKeys::RootType TopicKeys::root_type ( AST_Type *  type )

static

Get the RootType of the AST_Type

Definition at line 15 of file topic_keys.cpp.

References ArrayType, InvalidType, PrimitiveType, SequenceType, StructureType, and UnionType.

Referenced by marshal_generator::gen_typedef(), and TopicKeys::Iterator::Iterator().

{
  if (!type) {
    return InvalidType;
  }
  switch (type->unaliased_type()->node_type()) {
  case AST_Decl::NT_pre_defined:
  case AST_Decl::NT_string:
  case AST_Decl::NT_wstring:
  case AST_Decl::NT_enum:
    return PrimitiveType;
  case AST_Decl::NT_struct:
    return StructureType;
  case AST_Decl::NT_union:
    return UnionType;
  case AST_Decl::NT_array:
    return ArrayType;
  case AST_Decl::NT_sequence:
    return SequenceType;
  default:
    return InvalidType;
  }
}

root_type() [2/2]

TopicKeys::RootType TopicKeys::root_type

(

)

const

Definition at line 510 of file topic_keys.cpp.

References root_type_.

Referenced by TopicKeys::Iterator::Iterator().

{
  return root_type_;
}

Member Data Documentation

count_

size_t TopicKeys::count_

private

Definition at line 200 of file topic_keys.h.

Referenced by count(), and operator=().

counted_

bool TopicKeys::counted_

private

Cached Key Count {

Definition at line 199 of file topic_keys.h.

Referenced by count(), and operator=().

recursive_

bool TopicKeys::recursive_

private

}

Have iterators recurse into structures

Definition at line 204 of file topic_keys.h.

Referenced by operator=(), and recursive().

root_

AST_Decl* TopicKeys::root_

private

Definition at line 194 of file topic_keys.h.

Referenced by operator=(), root(), and TopicKeys().

root_type_

RootType TopicKeys::root_type_

private

Definition at line 195 of file topic_keys.h.

Referenced by operator=(), and root_type().

---

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

• topic_keys.h
• topic_keys.cpp