ObjCont Class Reference

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

#include <DictObjCont.h>

Inherited by DictObjCont, and ItemObjCont.

Inheritance diagram for ObjCont:

[legend]Collaboration diagram for ObjCont:

[legend]List of all members.

Public Member Functions
	ObjCont (FileNavigator &fileNav, DicFile &dicFile, const string &blockName, const string &id, const ObjContInfo &objContInfo)
virtual	~ObjCont ()
void	Init ()
string	GetName ()
virtual int	Read (uWord which, unsigned int Index=0)
virtual int	Write ()
const vector< string > &	GetAttribute (const string &catName, const string &itemName) const
void	Print ()
void	SetVerbose (bool verbose)
virtual void	Build ()
Protected Member Functions
virtual void	BuildItems (vector< vector< string > > &combo, const unsigned int configIndex)
virtual void	BuildItems (vector< vector< string > > &combo, const unsigned int configIndex, const string &value)
Protected Attributes
FileNavigator &	_fileNav
DicFile &	_dicFile
const ObjContInfo &	_objContInfo
string	_blockName
string	_id
bool	_verbose
vector< Word >	_index
vector< vector< vector< string > > >	_itemsStore
Private Member Functions
int	ReadItem (const pair< unsigned int, unsigned int > &indexPair, unsigned int Index)
int	WriteItem (const pair< unsigned int, unsigned int > &indices)

---

Detailed Description

Public class that represents a generic object container.

This class represents a generic object container of attributes. It is to be used directly or as a base class for non-generic object containers. This class provides methods for retrieving its attributes and printing its content.

---

Constructor & Destructor Documentation

ObjCont::ObjCont	(	FileNavigator &	fileNav,
		DicFile &	dicFile,
		const string &	blockName,
		const string &	id,
		const ObjContInfo &	objContInfo
	)

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

ObjCont::~ObjCont

(

)

[virtual]

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

---

Member Function Documentation

void ObjCont::Init

(

)

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

Reimplemented in DictObjCont.

string ObjCont::GetName

(

)

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

int ObjCont::Read	(	uWord	which,
		unsigned int	Index = 0
	)			[virtual]

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

int ObjCont::Write

(

)

[virtual]

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

Reimplemented in DictObjCont.

const vector< string > & ObjCont::GetAttribute	(	const string &	catName,
		const string &	itemName
	)			const

Retrieves a constant reference to the vector of values of the object container attribute, which is specified with a category name and an item name.

Parameters:

[in]	catName	- category name
[in]	itemName	- item name

Returns:

Constant reference to the vector of attribute values.

Precondition:

Category with name catName and item with name itemName must be present

Postcondition:

None

Exceptions:

NotFoundException

- if category with name catName or item with name itemName does not exist

void ObjCont::Print

(

)

Prints the content of the object container.

Parameters:

None

Returns:

None

Precondition:

None

Postcondition:

None

Exceptions:

None

Reimplemented in DictObjCont.

void ObjCont::SetVerbose

(

bool

verbose

)

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

void ObjCont::Build

(

)

[virtual]

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

Reimplemented in ItemObjCont, and DictObjCont.

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

Reimplemented in ItemObjCont, and DictObjCont.

void ObjCont::BuildItems	(	vector< vector< string > > &	combo,
		const unsigned int	configIndex,
		const string &	value
	)			[protected, virtual]

int ObjCont::ReadItem	(	const pair< unsigned int, unsigned int > &	indexPair,
		unsigned int	Index
	)			[private]

int ObjCont::WriteItem

(

const pair< unsigned int, unsigned int > &

indices

)

[private]

---

Member Data Documentation

FileNavigator& ObjCont::_fileNav [protected]

DicFile& ObjCont::_dicFile [protected]

const ObjContInfo& ObjCont::_objContInfo [protected]

string ObjCont::_blockName [protected]

string ObjCont::_id [protected]

bool ObjCont::_verbose [protected]

vector<Word> ObjCont::_index [protected]

vector<vector<vector<string> > > ObjCont::_itemsStore [protected]

---

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

• DictObjCont.h
• DictObjCont.C

---