EDoc::IndexedDictionary Class Reference

#include <libs/EDoc/IndexedDictionary.h>

---

Detailed Description

Manages all File, Type, FunctionType, and Function instances as they are being loaded from a EDoc++ data file.

This stores all items indexed by an integer value.

Definition at line 197 of file IndexedDictionary.h.

Public Member Functions
	IndexedDictionary (Dictionary &dict_in)
	Create an instance for loading data for the given dictionary.
std::vector< IndexedObject * >	GetManagedObjects ()
	Returns a vector with all managed types.
Data Fields
SpecificIndexedObject< File >	files
	Map of all File instances.
SpecificIndexedObject< Type >	types
	Map of all Type instances.
SpecificIndexedObject< FunctionType >	function_types
	Map of all FunctionType instances.
SpecificIndexedObject< Function >	functions
	Map of all Function instances.
Dictionary *	dict
	A reference to the dictionary all these instances belong to.
Friends
class	Dictionary

---

Constructor & Destructor Documentation

EDoc::IndexedDictionary::IndexedDictionary

(

EDoc::Dictionary &

dict_in

)

[inline]

Create an instance for loading data for the given dictionary.

Note:

EDoc++ data included.

Definition at line 205 of file IndexedDictionary.h.

---

Member Function Documentation

EDoc::IndexedDictionary::GetManagedObjects

(

)

[inline]

Returns a vector with all managed types.

This is a helper to simplify the code a little.

Definition at line 218 of file IndexedDictionary.h.

References files, function_types, functions, and types.

Referenced by EDoc::Dictionary::Read().

---

Friends And Related Function Documentation

friend class Dictionary [friend]

Definition at line 199 of file IndexedDictionary.h.

---

Field Documentation

SpecificIndexedObject<File> EDoc::IndexedDictionary::files

Map of all File instances.

Definition at line 233 of file IndexedDictionary.h.

Referenced by GetManagedObjects(), EDoc::Type::Read(), EDoc::Location::Read(), and EDoc::Function::Read().

SpecificIndexedObject<Type> EDoc::IndexedDictionary::types

Map of all Type instances.

Definition at line 238 of file IndexedDictionary.h.

Referenced by GetManagedObjects(), EDoc::TypeLoc::Read(), EDoc::Type::Read(), EDoc::FunctionType::Read(), and EDoc::Function::Read().

SpecificIndexedObject<FunctionType> EDoc::IndexedDictionary::function_types

Map of all FunctionType instances.

Definition at line 243 of file IndexedDictionary.h.

Referenced by GetManagedObjects(), EDoc::FunctionTypeLoc::Read(), and EDoc::Function::Read().

SpecificIndexedObject<Function> EDoc::IndexedDictionary::functions

Map of all Function instances.

Definition at line 248 of file IndexedDictionary.h.

Referenced by GetManagedObjects(), EDoc::FunctionLoc::Read(), and EDoc::Function::Read().

Dictionary* EDoc::IndexedDictionary::dict

A reference to the dictionary all these instances belong to.

Definition at line 253 of file IndexedDictionary.h.

Referenced by EDoc::Type::Read().

---

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

• libs/EDoc/IndexedDictionary.h
• libs.dox

---