makVrv::DtPageCollectionManager Class Reference

This class is a static singleton manager for getting page collection interfaces. More...

Inheritance diagram for makVrv::DtPageCollectionManager:

Public Types
typedef boost::unordered_map < std::string, DtPageCollection * >	CollectionMap

Public Member Functions
virtual	~DtPageCollectionManager ()
	DTOR.
DtPageCollection *	findPageCollection (const std::string &collectionClassName) const
	Find an instance of the page collection.
DtPageCollection *	assemblePageCollection (const std::string &collectionClassName) const
	Assemble a collection if it does not exist.
const CollectionMap &	pageCollections () const
	Get the map of all page collections.
void	showCollection (const std::string &collectionClassName, const std::string &page=std::string(""))
	Show a collection.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtPageCollectionManager &	instance (DtDe &de)
	Get access to the page collection instance for the DtDe.

Protected Member Functions
	DtPageCollectionManager (DtDe &de)
void	registerInstance (DtPageCollection *)
	Adds an instance of a DtPageCollection so it can be found by name.
void	unregisterInstance (DtPageCollection *)
	Removes an instance of a DtPageCollection so it will not b be found by name.

Protected Attributes
DtDe &	myDe
CollectionMap	myCollections

Friends
class	DtPageCollection
	Allow the page collection interface to register and unregister themselves.

Detailed Description

This class is a static singleton manager for getting page collection interfaces.

Member Typedef Documentation

typedef boost::unordered_map<std::string,DtPageCollection*> makVrv::DtPageCollectionManager::CollectionMap

Constructor & Destructor Documentation

virtual makVrv::DtPageCollectionManager::~DtPageCollectionManager ( )

virtual

DTOR.

makVrv::DtPageCollectionManager::DtPageCollectionManager ( DtDe &  de )

protected

Member Function Documentation

static DtPageCollectionManager& makVrv::DtPageCollectionManager::instance ( DtDe &  de )

static

Get access to the page collection instance for the DtDe.

DtPageCollection* makVrv::DtPageCollectionManager::findPageCollection

(

const std::string &

collectionClassName

)

const

Find an instance of the page collection.

DtPageCollection* makVrv::DtPageCollectionManager::assemblePageCollection

(

const std::string &

collectionClassName

)

const

Assemble a collection if it does not exist.

const CollectionMap& makVrv::DtPageCollectionManager::pageCollections

(

)

const

Get the map of all page collections.

void makVrv::DtPageCollectionManager::showCollection	(	const std::string &	collectionClassName,
		const std::string &	page = std::string("")
	)

Show a collection.

This is useful for displaying Dialog collections. Place the starting page as the second parameter, or, leave blank to default to page as defined in the collection

void makVrv::DtPageCollectionManager::registerInstance ( DtPageCollection *  )

protected

Adds an instance of a DtPageCollection so it can be found by name.

Exceptions

DtCorruptedState

if a page collection with the same name was already registered.

void makVrv::DtPageCollectionManager::unregisterInstance ( DtPageCollection *  )

protected

Removes an instance of a DtPageCollection so it will not b be found by name.

Friends And Related Function Documentation

friend class DtPageCollection

friend

Allow the page collection interface to register and unregister themselves.

Member Data Documentation

DtDe& makVrv::DtPageCollectionManager::myDe

protected

CollectionMap makVrv::DtPageCollectionManager::myCollections

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtPageCollectionManager.h