CTdiController

Heritage

Description

Enum

Friend

Protected Data Members

Public Methods

Constructor, Destructor, and Operator Methods

Updating Methods

Provider/Dependent Management Methods

Private Methods

Heritage

Subclasses: None

Description

• It does not register with the controller manager, so lifetime is controlled by the owning CNotifier.

• By default, it has a nullModel that always returns TRUE to changes.

• Possession of a pointer to a CTdiController implies access; therefore, for efficiency, CController::IsProvider() is not checked during updates. The only reason for maintaining a list of providers is for reference cleanup.

• Each dependent has the option of associating a prototype CTdiValue that copies data sent to that dependent. The CTdiValue is then sent along as the TDI message to the dependent.

• By checking the CurrentModel of each dependent, as well as the originator of each TDI value, the controller ensures that a TDI message does not make a round trip in a closed TDI connection graph.

Friend

Protected Data Members

Public Methods

CTdiController();

The controller's constructor. Unlike other controllers, the CTdiController does not accept a model, since TDI is not based on the use of a central model object. Instead, a dummy never-used model is automatically created here for you.

virtual ~CTdiController();

The destructor. Automatically removes the controller from each dependent notifier list of dependent controllers.

CTdiController(const CTdiController& theController);
CTdiController& operator=(
	const CTdiController& theController);

Copy constructor and assignment operator, which are disabled.

virtual BOOLEAN DoChange(
	const CNotifier* theProvider,
	long theCommand,
	const CTdiValue* theModel);

Propagates TDI messages to all dependents. Each dependent will receive the message, provided that it is not already processing or generating another one. TDI messaging is not currently reentrant. In addition, if a dependent has an associated prototype value, that value will be used to copy theModel. If the copying is successful, the prototype, along with its context message (if not NULL), will be sent to the dependent..

virtual BOOLEAN DoChange(
	const CNotifier* theProvider,
	long theCommand,
	const CModel* theModel);

Overrides the normal CController::DoChange() method. A run-time check is made to see if theModel is derived from CTdiValue. If so, the class's other DoChange() method above is invoked for TDI processing.

virtual BOOLEAN AssociateModel(
	CNotifier* theDependent,
	CTdiValue* thePrototype);

Associates a new prototype with the dependent. If the dependent has not been registered with the controller, the association fails and the method returns FALSE. Otherwise, any previously associated prototype is destroyed, and the new one is consumed.

virtual BOOLEAN AddDependent(
	CNotifier* theDependent,
	CTdiValue* thePrototype);

Registers a dependent and a prototype with the controller. The prototype may be NULL. See DoChange() for information about how theDependent and thePrototype are used during TDI processing. If the prototype is not NULL, the pointer is consumed; that is, the responsibility for destroying the prototype is transferred to the controller. The method returns FALSE if the dependent has been registered previously, making further registration fail.

virtual BOOLEAN AddDependent(
	CNotifier* theDependent);

Overrides inherited method. Calling the method is equivalent to calling AddDependent with a NULL prototype.

virtual BOOLEAN RemoveDependent(
	CNotifier* theDependent, 
	CTdiValue*& thePrototype);

Removes a dependent from the controller. If the dependent has an associated prototype, a pointer to it is returned via thePrototype, and the responsibility for its destruction is transferred to the caller.

virtual BOOLEAN RemoveDependent(
	CNotifier* theDependent);

Removes the dependent and destroys any associated prototype value.

virtual BOOLEAN AddProvider(
	CNotifier* theProvider);

Provides same behavior as inherited CController::AddProvider.

virtual const RWOrdered* GetDependents() const;

Not supported. Always returns NULL.

virtual BOOLEAN IsDependent(
	const CNotifier* theDependent) const;

Returns TRUE if theDependent is registered with the controller.

virtual void Suspend();
virtual void Resume();

These methods suspend/resume TDI notification. Can be nested.

void SetActiveDependent(CNotifier* theDependent);
CNotifier* GetActiveDependent() const;

These methods allow you to get and set a temporarily active dependent. TDI notifications are sent only to the active dependent. To reset notification to all dependents, call SetActiveDependent with a NULL pointer.

BOOLEAN IsOriginator(
	const CTdiValue* theModel,
	const CNotifier* theNotifier);

Returns TRUE if theNotifier originally created theModel's data.