DtAssistantSignalRouter Class Reference

At startup all of the assistant manager classes will register their signals and slots with the signal router. More...

Collaboration diagram for DtAssistantSignalRouter:

Public Member Functions
	DtAssistantSignalRouter ()
	Constructor. More...
	~DtAssistantSignalRouter ()
	Destructor. More...
void	connectSignals ()
	Establishes connections between the various signals and slot. More...
void	registerSignal (DtAssistantSignalId sigId, QObject *obj, const char *sig)
	Register a signal. More...
void	registerSlot (DtAssistantSignalId sigId, QObject *obj, const char *slot)
	Register a slot. More...
void	registerQuery (DtAssistantQueryId queryId, QObject *obj, const char *sig)
	Register a signal to generate a query. More...
bool	registerQueryResponder (DtAssistantQueryId queryId, QObject *obj, const char *slot)
	Register a slot to process and respond to a query. More...
void	printMappings ()
	Print the signal/slot mappings. More...

Protected Types
typedef std::map < DtAssistantSignalId, const char * >	DtObjectSignalMap
typedef std::map < DtAssistantQueryId, const char * >	DtObjectQueryMap

Protected Attributes
std::vector< DtSignalMappings >	mySignalMappings
	Signal/slot mappings for each of the signal IDs. More...
std::vector< DtQueryMappings >	myQueryMappings
	Signal/slot mappings for each of the query IDs. More...
std::set< QObject * >	myMappedObjects
std::map< QObject *, DtObjectSignalMap >	myObjectSignalMappings
std::map< QObject *, DtObjectSignalMap >	myObjectSlotMappings
std::map< QObject *, DtObjectQueryMap >	myObjectQueryMappings

Private Member Functions
	DtAssistantSignalRouter (DtAssistantSignalRouter const &)
	Copy Constructor not implemented – Copy Not Allowed! More...
DtAssistantSignalRouter &	operator= (DtAssistantSignalRouter const &)
	Assignment not implemented – Assignment Not Allowed! More...

Detailed Description

At startup all of the assistant manager classes will register their signals and slots with the signal router.

The signal router will then ensure that they are all appropriated connected, without the need for each manager to understand who is responsible for handling its command or query.

Member Typedef Documentation

typedef std::map<DtAssistantQueryId, const char*> DtAssistantSignalRouter::DtObjectQueryMap

protected

typedef std::map<DtAssistantSignalId, const char*> DtAssistantSignalRouter::DtObjectSignalMap

protected

Constructor & Destructor Documentation

DtAssistantSignalRouter::DtAssistantSignalRouter

(

)

Constructor.

DtAssistantSignalRouter::~DtAssistantSignalRouter

(

)

Destructor.

DtAssistantSignalRouter::DtAssistantSignalRouter ( DtAssistantSignalRouter const &  )

private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

void DtAssistantSignalRouter::connectSignals

(

)

Establishes connections between the various signals and slot.

All signals and slots must be registered prior to calling this.

DtAssistantSignalRouter& DtAssistantSignalRouter::operator= ( DtAssistantSignalRouter const &  )

private

Assignment not implemented – Assignment Not Allowed!

void DtAssistantSignalRouter::printMappings

(

)

Print the signal/slot mappings.

void DtAssistantSignalRouter::registerQuery	(	DtAssistantQueryId	queryId,
		QObject *	obj,
		const char *	sig
	)

Register a signal to generate a query.

A query can have many queriers but only one query responder. Generally one of the parameters will be a an output parameter with the query response.

bool DtAssistantSignalRouter::registerQueryResponder	(	DtAssistantQueryId	queryId,
		QObject *	obj,
		const char *	slot
	)

Register a slot to process and respond to a query.

A query can have many queriers but only one query responder. Will return false if a responder has already been registered for this query. Generally one of the parameters will be a an output parameter with the query response.

void DtAssistantSignalRouter::registerSignal	(	DtAssistantSignalId	sigId,
		QObject *	obj,
		const char *	sig
	)

Register a signal.

void DtAssistantSignalRouter::registerSlot	(	DtAssistantSignalId	sigId,
		QObject *	obj,
		const char *	slot
	)

Register a slot.

In reality this can also be another signal if a manager would like to simply pass the signal on to widgets it manages.

Member Data Documentation

std::set<QObject*> DtAssistantSignalRouter::myMappedObjects

protected

std::map<QObject*, DtObjectQueryMap> DtAssistantSignalRouter::myObjectQueryMappings

protected

std::map<QObject*, DtObjectSignalMap> DtAssistantSignalRouter::myObjectSignalMappings

protected

std::map<QObject*, DtObjectSignalMap> DtAssistantSignalRouter::myObjectSlotMappings

protected

std::vector<DtQueryMappings> DtAssistantSignalRouter::myQueryMappings

protected

Signal/slot mappings for each of the query IDs.

std::vector<DtSignalMappings> DtAssistantSignalRouter::mySignalMappings

protected

Signal/slot mappings for each of the signal IDs.

---

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

• assistantSignalRouter.h