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

#include <Dictionary.hh>

Classes
struct	node_type
struct	object_hash
struct	object_ptr_hash
struct	streamref_hash

Public Types
typedef FrameSpec::Object *	object_ptr_type
typedef boost::shared_ptr< FrameSpec::Object >	object_type
typedef boost::shared_ptr< StreamRefInterface >	streamref_type
typedef std::pair< StreamRefInterface::class_type, StreamRefInterface::instance_type >	ptr_struct_key_type
typedef FrameSpec::Object *	object_ptr_type
typedef boost::shared_ptr< FrameSpec::Object >	object_type
typedef boost::shared_ptr< 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.
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
	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.
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

Private Types
typedef const streamref_type::element_type *	const_streamref_type
typedef LDASTools::AL::unordered_map< object_type, streamref_type, object_hash >	streamref_container_type
typedef LDASTools::AL::unordered_map< streamref_type, object_type, streamref_hash >	object_container_type
typedef LDASTools::AL::unordered_map< FrameSpec::class_type, FrameSpec::instance_type >	instance_count_container_type
typedef LDASTools::AL::unordered_map< object_ptr_type, node_type, object_ptr_hash >	next_container_type
typedef std::map< ptr_struct_key_type, streamref_type >	streamref_by_id_container_type
typedef const streamref_type::element_type *	const_streamref_type
typedef LDASTools::AL::unordered_map< object_type, streamref_type, object_hash >	streamref_container_type
typedef LDASTools::AL::unordered_map< streamref_type, object_type, streamref_hash >	object_container_type
typedef LDASTools::AL::unordered_map< FrameSpec::class_type, FrameSpec::instance_type >	instance_count_container_type
typedef LDASTools::AL::unordered_map< object_ptr_type, node_type, object_ptr_hash >	next_container_type
typedef std::map< ptr_struct_key_type, streamref_type >	streamref_by_id_container_type

Private Attributes
const_streamref_type	m_stream_ref
streamref_container_type	m_streamref_container
object_container_type	m_object_container
instance_count_container_type	m_instance_count_container
next_container_type	m_next_container
streamref_by_id_container_type	m_streamref_by_id_container

Friends
class	FrameStream

Detailed Description

Keep track of structures written to or read from stream.

Member Typedef Documentation

◆ const_streamref_type [1/2]

typedef const streamref_type::element_type* FrameCPP::Common::Dictionary::const_streamref_type

private

◆ const_streamref_type [2/2]

typedef const streamref_type::element_type* FrameCPP::Common::Dictionary::const_streamref_type

private

◆ instance_count_container_type [1/2]

typedef LDASTools::AL::unordered_map< FrameSpec::class_type, FrameSpec::instance_type > FrameCPP::Common::Dictionary::instance_count_container_type

private

◆ instance_count_container_type [2/2]

typedef LDASTools::AL::unordered_map< FrameSpec::class_type, FrameSpec::instance_type > FrameCPP::Common::Dictionary::instance_count_container_type

private

◆ next_container_type [1/2]

typedef LDASTools::AL:: unordered_map< object_ptr_type, node_type, object_ptr_hash > FrameCPP::Common::Dictionary::next_container_type

private

◆ next_container_type [2/2]

typedef LDASTools::AL:: unordered_map< object_ptr_type, node_type, object_ptr_hash > FrameCPP::Common::Dictionary::next_container_type

private

◆ object_container_type [1/2]

typedef LDASTools::AL:: unordered_map< streamref_type, object_type, streamref_hash > FrameCPP::Common::Dictionary::object_container_type

private

◆ object_container_type [2/2]

typedef LDASTools::AL:: unordered_map< streamref_type, object_type, streamref_hash > FrameCPP::Common::Dictionary::object_container_type

private

◆ object_ptr_type [1/2]

typedef FrameSpec::Object* FrameCPP::Common::Dictionary::object_ptr_type

◆ object_ptr_type [2/2]

typedef FrameSpec::Object* FrameCPP::Common::Dictionary::object_ptr_type

◆ object_type [1/2]

typedef boost::shared_ptr< FrameSpec::Object > FrameCPP::Common::Dictionary::object_type

◆ object_type [2/2]

typedef boost::shared_ptr< FrameSpec::Object > FrameCPP::Common::Dictionary::object_type

◆ ptr_struct_key_type [1/2]

typedef std::pair< StreamRefInterface::class_type, StreamRefInterface::instance_type > FrameCPP::Common::Dictionary::ptr_struct_key_type

◆ ptr_struct_key_type [2/2]

typedef std::pair< StreamRefInterface::class_type, StreamRefInterface::instance_type > FrameCPP::Common::Dictionary::ptr_struct_key_type

◆ streamref_by_id_container_type [1/2]

typedef std::map< ptr_struct_key_type, streamref_type > FrameCPP::Common::Dictionary::streamref_by_id_container_type

private

◆ streamref_by_id_container_type [2/2]

typedef std::map< ptr_struct_key_type, streamref_type > FrameCPP::Common::Dictionary::streamref_by_id_container_type

private

◆ streamref_container_type [1/2]

typedef LDASTools::AL:: unordered_map< object_type, streamref_type, object_hash > FrameCPP::Common::Dictionary::streamref_container_type

private

◆ streamref_container_type [2/2]

typedef LDASTools::AL:: unordered_map< object_type, streamref_type, object_hash > FrameCPP::Common::Dictionary::streamref_container_type

private

◆ streamref_type [1/2]

typedef boost::shared_ptr< StreamRefInterface > FrameCPP::Common::Dictionary::streamref_type

◆ streamref_type [2/2]

typedef boost::shared_ptr< StreamRefInterface > FrameCPP::Common::Dictionary::streamref_type

Constructor & Destructor Documentation

◆ Dictionary() [1/2]

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

◆ ~Dictionary() [1/2]

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

◆ Dictionary() [2/2]

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

◆ ~Dictionary() [2/2]

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

Member Function Documentation

◆ Clear() [1/2]

void FrameCPP::Common::Dictionary::Clear ( )

inline

◆ Clear() [2/2]

void FrameCPP::Common::Dictionary::Clear ( )

◆ Next() [1/6]

Dictionary::object_type FrameCPP::Common::Dictionary::Next ( const object_type::element_type * Obj ) const

inline

◆ Next() [2/6]

object_type FrameCPP::Common::Dictionary::Next ( const object_type::element_type * Obj ) const

◆ Next() [3/6]

Dictionary::object_type FrameCPP::Common::Dictionary::Next ( object_type Obj ) const

inline

◆ Next() [4/6]

object_type FrameCPP::Common::Dictionary::Next ( object_type Obj ) const

◆ Next() [5/6]

void FrameCPP::Common::Dictionary::Next	(	object_type	Obj,
		object_type	Next )

inline

◆ Next() [6/6]

void FrameCPP::Common::Dictionary::Next	(	object_type	Obj,
		object_type	Next )

◆ Ref() [1/8]

Dictionary::streamref_type FrameCPP::Common::Dictionary::Ref ( const ptr_struct_key_type & Key ) const

inline

◆ Ref() [2/8]

streamref_type FrameCPP::Common::Dictionary::Ref ( const ptr_struct_key_type & Key ) const

◆ Ref() [3/8]

Dictionary::streamref_type FrameCPP::Common::Dictionary::Ref ( object_type Obj ) const

inline

◆ Ref() [4/8]

streamref_type FrameCPP::Common::Dictionary::Ref ( object_type Obj ) const

◆ Ref() [5/8]

Dictionary::object_type FrameCPP::Common::Dictionary::Ref ( streamref_type SR ) const

inline

◆ Ref() [6/8]

object_type FrameCPP::Common::Dictionary::Ref ( streamref_type SR ) const

◆ Ref() [7/8]

void FrameCPP::Common::Dictionary::Ref	(	streamref_type	SR,
		object_type	Obj )

inline

◆ Ref() [8/8]

void FrameCPP::Common::Dictionary::Ref	(	streamref_type	SR,
		object_type	Obj )

◆ RefCreate() [1/2]

Dictionary::streamref_type FrameCPP::Common::Dictionary::RefCreate	(	object_type	Obj,
		const OStream &	Stream )

inline

Create a reference.

Parameters

[in]	Obj	Object to be referenced.
[in]	Stream	Stream 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.

◆ RefCreate() [2/2]

streamref_type FrameCPP::Common::Dictionary::RefCreate	(	object_type	Obj,
		const OStream &	Stream )

Create a reference.

Parameters

[in]	Obj	Object to be referenced.
[in]	Stream	Stream to receive the reference.

Returns

A reference to Obj appropriate for the Stream.

◆ Remove() [1/4]

void FrameCPP::Common::Dictionary::Remove ( const ptr_struct_key_type & Key )

inline

◆ Remove() [2/4]

void FrameCPP::Common::Dictionary::Remove ( const ptr_struct_key_type & Key )

◆ Remove() [3/4]

void FrameCPP::Common::Dictionary::Remove ( object_type Key )

inline

◆ Remove() [4/4]

void FrameCPP::Common::Dictionary::Remove ( object_type Key )

◆ ResetInstanceCounts() [1/2]

void FrameCPP::Common::Dictionary::ResetInstanceCounts ( )

inline

◆ ResetInstanceCounts() [2/2]

void FrameCPP::Common::Dictionary::ResetInstanceCounts ( )

◆ SetInstance() [1/2]

void FrameCPP::Common::Dictionary::SetInstance ( streamref_type StreamRef )

◆ SetInstance() [2/2]

void FrameCPP::Common::Dictionary::SetInstance ( streamref_type StreamRef )

◆ FrameStream

FrameStream

friend

Member Data Documentation

◆ m_instance_count_container

instance_count_container_type FrameCPP::Common::Dictionary::m_instance_count_container

private

◆ m_next_container

next_container_type FrameCPP::Common::Dictionary::m_next_container

private

◆ m_object_container

object_container_type FrameCPP::Common::Dictionary::m_object_container

private

◆ m_stream_ref

const_streamref_type FrameCPP::Common::Dictionary::m_stream_ref

private

◆ m_streamref_by_id_container

streamref_by_id_container_type FrameCPP::Common::Dictionary::m_streamref_by_id_container

private

◆ m_streamref_container

streamref_container_type FrameCPP::Common::Dictionary::m_streamref_container

private

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

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Common/Dictionary.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/Dictionary.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/Dictionary.cc

Classes

Public Types

Public Member Functions

Private Types

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_streamref_type [1/2]

◆ const_streamref_type [2/2]

◆ instance_count_container_type [1/2]

◆ instance_count_container_type [2/2]

◆ next_container_type [1/2]

◆ next_container_type [2/2]

◆ object_container_type [1/2]

◆ object_container_type [2/2]

◆ object_ptr_type [1/2]

◆ object_ptr_type [2/2]

◆ object_type [1/2]

◆ object_type [2/2]

◆ ptr_struct_key_type [1/2]

◆ ptr_struct_key_type [2/2]

◆ streamref_by_id_container_type [1/2]

◆ streamref_by_id_container_type [2/2]

◆ streamref_container_type [1/2]

◆ streamref_container_type [2/2]

◆ streamref_type [1/2]

◆ streamref_type [2/2]

Constructor & Destructor Documentation

◆ Dictionary() [1/2]

◆ ~Dictionary() [1/2]

◆ Dictionary() [2/2]

◆ ~Dictionary() [2/2]

Member Function Documentation

◆ Clear() [1/2]

◆ Clear() [2/2]

◆ Next() [1/6]

◆ Next() [2/6]

◆ Next() [3/6]

◆ Next() [4/6]

◆ Next() [5/6]

◆ Next() [6/6]

◆ Ref() [1/8]

◆ Ref() [2/8]

◆ Ref() [3/8]

◆ Ref() [4/8]

◆ Ref() [5/8]

◆ Ref() [6/8]

◆ Ref() [7/8]

◆ Ref() [8/8]

◆ RefCreate() [1/2]

A reference to Obj appropriate for the Stream.

◆ RefCreate() [2/2]

A reference to Obj appropriate for the Stream.

◆ Remove() [1/4]

◆ Remove() [2/4]

◆ Remove() [3/4]

◆ Remove() [4/4]

◆ ResetInstanceCounts() [1/2]

◆ ResetInstanceCounts() [2/2]

◆ SetInstance() [1/2]

◆ SetInstance() [2/2]

Friends And Related Symbol Documentation

◆ FrameStream

Member Data Documentation

◆ m_instance_count_container

◆ m_next_container

◆ m_object_container

◆ m_stream_ref

◆ m_streamref_by_id_container

◆ m_streamref_container