Class Index Cross Index Namespace Index

Class FrameCPP::Version_6::Dictionary


Contained in: FrameCPP::Version_6
Derived from: none
Derived by: none

#include "../../../../../lib/framecpp/src/Version6/Dictionary.hh"


public function member index:

Dictionary(const std::vector< io_calls_type >& LibraryDefs, INT_4U NumberOfClassTypes); Constructor
~Dictionary(); Destructor
const callback_key_type AddCallback(INT_2U Key, Callback& CB); Add a callback method to the dictionary
void AddDefinition(const definition_type* Definition); Add a definition to the dictionary
void DisableLibraryReaderAll();
void EnableLibraryReader(INT_4U ClassId);
void EnableLibraryReaderAll();
INT_2U GetLibraryClass(const std::string& Name) const; Get the class id for the library based on text name
bool IsReadable(IFrameStream& Stream, const FrBase& Base) const;
INT_2U MapStreamClassToLibraryClass(INT_2U StreamClass) const;
FrBase* Read(IFrameStream& Stream, const FrBase& Base); Read element off the stream
void RemoveCallback(const callback_key_type Key); Remove a callback method from the dictionary
void TrackObjects(bool Tracking);
void Write(OFrameStream& Stream, FrBase& Base); Write element the stream
 

private function member index:

void add_class_mapping(INT_2U StreamClass, INT_2U LibraryClass);
void key_checkin(key_id_type Key); Release key to the pool
key_id_type key_checkout(); Obtain a key from the pool
 

Description:



Function Member Descriptions:


FrameCPP::Version_6::Dictionary::Dictionary - Constructor


Dictionary(const std::vector< io_calls_type >& LibraryDefs, INT_4U NumberOfClassTypes);



FrameCPP::Version_6::Dictionary::~Dictionary - Destructor


~Dictionary();



FrameCPP::Version_6::Dictionary::AddCallback - Add a callback method to the dictionary


const callback_key_type AddCallback(INT_2U Key, Callback& CB);



FrameCPP::Version_6::Dictionary::AddDefinition - Add a definition to the dictionary


void AddDefinition(const definition_type* Definition);
This function adds a definition to the dictionary. It is greedy in that it takes ownership of the pointer past and will delete the object when the dictionary




FrameCPP::Version_6::Dictionary::DisableLibraryReaderAll


void DisableLibraryReaderAll();



FrameCPP::Version_6::Dictionary::EnableLibraryReader


void EnableLibraryReader(INT_4U ClassId);



FrameCPP::Version_6::Dictionary::EnableLibraryReaderAll


void EnableLibraryReaderAll();



FrameCPP::Version_6::Dictionary::GetLibraryClass - Get the class id for the library based on text name


INT_2U GetLibraryClass(const std::string& Name) const;



FrameCPP::Version_6::Dictionary::IsReadable


bool IsReadable(IFrameStream& Stream, const FrBase& Base) const;



FrameCPP::Version_6::Dictionary::MapStreamClassToLibraryClass


INT_2U MapStreamClassToLibraryClass(INT_2U StreamClass) const;



FrameCPP::Version_6::Dictionary::Read - Read element off the stream


FrBase* Read(IFrameStream& Stream, const FrBase& Base);



FrameCPP::Version_6::Dictionary::RemoveCallback - Remove a callback method from the dictionary


void RemoveCallback(const callback_key_type Key);



FrameCPP::Version_6::Dictionary::TrackObjects


void TrackObjects(bool Tracking);



FrameCPP::Version_6::Dictionary::Write - Write element the stream


void Write(OFrameStream& Stream, FrBase& Base);



FrameCPP::Version_6::Dictionary::add_class_mapping


void add_class_mapping(INT_2U StreamClass, INT_2U LibraryClass);



FrameCPP::Version_6::Dictionary::key_checkin - Release key to the pool


void key_checkin(key_id_type Key);



FrameCPP::Version_6::Dictionary::key_checkout - Obtain a key from the pool


key_id_type key_checkout();



Variable Member Descriptions:


FrameCPP::Version_6::Dictionary::m_callbacks -

callback_map_type m_callbacks;
List of callbacks


FrameCPP::Version_6::Dictionary::m_described_instance -

described_instance_type m_described_instance;
Mapping of registered callbacks registered_callbacks_type m_registered_callbacks; Associative array tracking number of instances.


FrameCPP::Version_6::Dictionary::m_key_chain - Bookkeeping of keys currently in use

key_chain_type m_key_chain;
If a key is checked out, then a value of true is registered at the the key's index, false otherwise.


FrameCPP::Version_6::Dictionary::m_lib_to_stream -

mutable id_map_type m_lib_to_stream;
Map of class ids from library structures to stream structures


FrameCPP::Version_6::Dictionary::m_library_defs -

library_defs_type m_library_defs;
Map of structues provied by the library.


FrameCPP::Version_6::Dictionary::m_library_map -

library_map_type m_library_map;
Map associating a name with a class id for the library.


FrameCPP::Version_6::Dictionary::m_reference_info -

Reference m_reference_info;

FrameCPP::Version_6::Dictionary::m_stream_defs -

stream_defs_type m_stream_defs;
Map of definitions of structures either read in or written to the stream


FrameCPP::Version_6::Dictionary::m_stream_to_lib -

id_map_type m_stream_to_lib;
Map of class ids from stream structures to library structures