DictObjCont Class Reference

Public class that represents a dictionary object container. More...

#include <DictObjCont.h>

Inherits ObjCont.

Inheritance diagram for DictObjCont:

[legend]Collaboration diagram for DictObjCont:

[legend]List of all members.

Public Member Functions
	DictObjCont (Serializer &ser, const string &blockName)
	DictObjCont (Serializer &ser, DicFile &dicFile, const string &blockName)
	~DictObjCont ()
void	Build ()
UInt32	Write ()
void	Read (UInt32 which, unsigned int Index=0)
const ObjCont &	GetObjCont (const string &contName, const ObjContInfo &objContInfo)
void	Print ()
Private Member Functions
	DictObjCont (const DictObjCont &dictObjCont)
DictObjCont &	operator= (const DictObjCont &inDictObjCont)
void	Init ()
UInt32	WriteContLocations (const vector< UInt32 > &indices)
void	BuildContainers (unsigned int index, const string &catName, const string &itemName, mapped_ptr_vector< ObjCont > &containers)
void	BuildItems (vector< vector< string > > &combo, const unsigned int configIndex)
ObjCont &	GetContainers (const string &contName, mapped_ptr_vector< ObjCont > &containers, const ObjContInfo &objContInfo)
void	PrintContainers (const string &catName, const string &itemName, const ObjContInfo &objContInfo)
Private Attributes
mapped_ptr_vector< ObjCont >	_items
mapped_ptr_vector< ObjCont >	_subcategories
mapped_ptr_vector< ObjCont >	_categories

---

Detailed Description

Public class that represents a dictionary object container.

This class represents a dictionary object container, i.e., an object container of type "dictionary". A dictionary object container is a container of its attributes and of objects of type: item, sub-category and category. In addition to ObjCont features, this class has a method to get references to other object containers that it contains.

---

Constructor & Destructor Documentation

DictObjCont::DictObjCont	(	Serializer &	ser,
		const string &	blockName
	)

Utility method, not part of users public API, and will soon be removed.

DictObjCont::DictObjCont	(	Serializer &	ser,
		DicFile &	dicFile,
		const string &	blockName
	)

Utility method, not part of users public API, and will soon be removed.

DictObjCont::~DictObjCont

(

)

Utility method, not part of users public API, and will soon be removed.

DictObjCont::DictObjCont

(

const DictObjCont &

dictObjCont

)

[private]

---

Member Function Documentation

void DictObjCont::Build

(

)

[virtual]

Utility method, not part of users public API, and will soon be removed.

Reimplemented from ObjCont.

UInt32 DictObjCont::Write

(

)

[virtual]

Utility method, not part of users public API, and will soon be removed.

Reimplemented from ObjCont.

void DictObjCont::Read	(	UInt32	which,
		unsigned int	Index = 0
	)			[virtual]

Utility method, not part of users public API, and will soon be removed.

Reimplemented from ObjCont.

const ObjCont & DictObjCont::GetObjCont	(	const string &	contName,
		const ObjContInfo &	objContInfo
	)

Retrieves a reference to the generic object container, which is specified with its name and its type.

Parameters:

[in]	contName	- object container name
[in]	objContInfo	- reference to the object container information, that defines object container's type. It can have the following values: RcsbItem - indicates that the object container is of type "item" RcsbSubcat - indicates that the object container is of type "sub-category" RcsbCat - indicates that the object container is of type "category"

Returns:

Reference to the generic object container

Precondition:

Object container with name contName must be present

Postcondition:

None

Exceptions:

NotFoundException

- if object container with name contName does not exist

void DictObjCont::Print

(

)

Prints the content of the object container, which includes its attributes and the content of all the object containers that it contains.

Parameters:

None

Returns:

None

Precondition:

None

Postcondition:

None

Exceptions:

None

DictObjCont& DictObjCont::operator=

(

const DictObjCont &

inDictObjCont

)

[private]

void DictObjCont::Init

(

)

[private]

Utility method, not part of users public API, and will soon be removed.

Reimplemented from ObjCont.

UInt32 DictObjCont::WriteContLocations

(

const vector< UInt32 > &

indices

)

[private]

void DictObjCont::BuildContainers	(	unsigned int	index,
		const string &	catName,
		const string &	itemName,
		mapped_ptr_vector< ObjCont > &	containers
	)			[private]

void DictObjCont::BuildItems	(	vector< vector< string > > &	combo,
		const unsigned int	configIndex
	)			[private, virtual]

Reimplemented from ObjCont.

ObjCont & DictObjCont::GetContainers	(	const string &	contName,
		mapped_ptr_vector< ObjCont > &	containers,
		const ObjContInfo &	objContInfo
	)			[private]

void DictObjCont::PrintContainers	(	const string &	catName,
		const string &	itemName,
		const ObjContInfo &	objContInfo
	)			[private]

---

Member Data Documentation

mapped_ptr_vector<ObjCont> DictObjCont::_items [private]

mapped_ptr_vector<ObjCont> DictObjCont::_subcategories [private]

mapped_ptr_vector<ObjCont> DictObjCont::_categories [private]

---

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

• DictObjCont.h
• DictObjCont.C

---