ldas-tools-framecpp  2.5.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Friends | List of all members
FrameCPP::Common::Dictionary Class Reference

Keep track of structures written to or read from stream. More...

#include <Dictionary.hh>

Public Types

typedef FrameSpec::Objectobject_ptr_type
 
typedef
LDASTools::AL::SharedPtr
< FrameSpec::Object
object_type
 
typedef
LDASTools::AL::SharedPtr
< StreamRefInterface
streamref_type
 
typedef std::pair
< StreamRefInterface::class_type,
StreamRefInterface::instance_type
ptr_struct_key_type
 

Public Member Functions

 Dictionary ()
 
 ~Dictionary ()
 
void Clear ()
 
streamref_type Ref (const ptr_struct_key_type &Key) const
 
object_type Ref (streamref_type SR) const
 
streamref_type Ref (object_type Obj) const
 
void Ref (streamref_type SR, object_type Obj)
 
streamref_type RefCreate (object_type Obj, const OStream &Stream)
 Create a reference. More...
 
void Remove (const ptr_struct_key_type &Key)
 
void Remove (object_type Key)
 
void ResetInstanceCounts ()
 
void SetInstance (streamref_type StreamRef)
 
void Next (object_type Obj, object_type Next)
 
object_type Next (object_type Obj) const
 
object_type Next (const object_type::element_type *Obj) const
 

Friends

class FrameStream
 

Detailed Description

Keep track of structures written to or read from stream.

Member Typedef Documentation

typedef LDASTools::AL::SharedPtr< FrameSpec::Object > FrameCPP::Common::Dictionary::object_type

Constructor & Destructor Documentation

FrameCPP::Common::Dictionary::Dictionary ( )
FrameCPP::Common::Dictionary::~Dictionary ( )

Member Function Documentation

void FrameCPP::Common::Dictionary::Clear ( )
inline
void FrameCPP::Common::Dictionary::Next ( object_type  Obj,
object_type  Next 
)
inline
Dictionary::object_type FrameCPP::Common::Dictionary::Next ( object_type  Obj) const
inline
Dictionary::object_type FrameCPP::Common::Dictionary::Next ( const object_type::element_type *  Obj) const
inline
Dictionary::streamref_type FrameCPP::Common::Dictionary::Ref ( const ptr_struct_key_type Key) const
inline
Dictionary::object_type FrameCPP::Common::Dictionary::Ref ( streamref_type  SR) const
inline
Dictionary::streamref_type FrameCPP::Common::Dictionary::Ref ( object_type  Obj) const
inline
void FrameCPP::Common::Dictionary::Ref ( streamref_type  SR,
object_type  Obj 
)
inline
Dictionary::streamref_type FrameCPP::Common::Dictionary::RefCreate ( object_type  Obj,
const OStream Stream 
)
inline

Create a reference.


Parameters
[in]ObjObject to be referenced.
[in]StreamStream to receive the reference.
Returns

A reference to Obj appropriate for the Stream.

This method is used for creating a reference that would be appropriate for writing to a stream.

void FrameCPP::Common::Dictionary::Remove ( const ptr_struct_key_type Key)
inline
void FrameCPP::Common::Dictionary::Remove ( object_type  Key)
inline
void FrameCPP::Common::Dictionary::ResetInstanceCounts ( )
inline
void FrameCPP::Common::Dictionary::SetInstance ( streamref_type  StreamRef)

Friends And Related Function Documentation

friend class FrameStream
friend

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