PureMVC::SimpleCommand Class Reference

A base ICommand implementation. More...

#include <pmvcpp.h>

Inheritance diagram for PureMVC::SimpleCommand:

[legend]

Collaboration diagram for PureMVC::SimpleCommand:

[legend]

List of all members.

Public Member Functions
virtual void	execute (INotification *notification)=0
	Execute the ICommand's logic to handle a given INotification.
void	sendNotification (int notificationName, void *body, int notificationType)
	Create and send an INotification.
void	sendNotification (int notificationName, int notificationType)
	Send a INotification.
void	sendNotification (int notificationName, void *body)
	Send a INotification.
void	sendNotification (int notificationName)
	Send a INotification.
void	initializeNotifier (std::string key)
	Initialize this INotifier instance.
virtual void	setMultitonKey (std::string key)
	Set multiton key.
virtual std::string	getMultitonKey ()
	Get multiton key.
Protected Member Functions
IFacade *	getFacade ()

---

Detailed Description

A base ICommand implementation.

Your subclass should override the execute method where your business logic will handle the INotification.

See also:

Controller::Controller

Notification::Notification

MacroCommand::MacroCommand

---

Member Function Documentation

virtual void PureMVC::SimpleCommand::execute

(

INotification *

notification

)

[pure virtual]

Execute the ICommand's logic to handle a given INotification.

Parameters:

note

an INotification to handle.

Implements PureMVC::ICommand.

Implemented in PureMVC::MacroCommand.

std::string MultitonKeyHeir::getMultitonKey

(

)

[virtual, inherited]

Get multiton key.

Returns the multiton key.

Returns:

The string key name

Implements PureMVC::IMultitonKeyHeir.

void Notifier::initializeNotifier

(

std::string

key

)

[virtual, inherited]

Initialize this INotifier instance.

This is how a Notifier gets its multitonKey. Calls to sendNotification or to access the facade will fail until after this method has been called.

Mediators, Commands or Proxies may override this method in order to send notifications or access the Multiton Facade instance as soon as possible. They CANNOT access the facade in their constructors, since this method will not yet have been called.

Parameters:

key

the multitonKey for this INotifier to use

Implements PureMVC::INotifier.

void Notifier::sendNotification

(

int

notificationName

)

[virtual, inherited]

Send a INotification.

Convenience method to prevent having to construct new notification instances in our implementation code.

Parameters:

notificationName

the name of the notification to send

Implements PureMVC::INotifier.

void Notifier::sendNotification	(	int	notificationName,
		void *	body
	)			[virtual, inherited]

Send a INotification.

Convenience method to prevent having to construct new notification instances in our implementation code.

Parameters:

	notificationName	the name of the notification to send
	body	the body of the notification (optional)

Implements PureMVC::INotifier.

void Notifier::sendNotification	(	int	notificationName,
		int	notificationType
	)			[virtual, inherited]

Send a INotification.

Convenience method to prevent having to construct new notification instances in our implementation code.

Parameters:

	notificationName	the name of the notification to send
	type	the type of the notification (optional)

Implements PureMVC::INotifier.

void Notifier::sendNotification	(	int	notificationName,
		void *	body,
		int	notificationType
	)			[virtual, inherited]

Create and send an INotification.

Keeps us from having to construct new INotification instances in our implementation code.

Parameters:

	notificationName	the name of the notiification to send
	body	the body of the notification (optional)
	type	the type of the notification (optional)

Implements PureMVC::INotifier.

void MultitonKeyHeir::setMultitonKey

(

std::string

key

)

[virtual, inherited]

Set multiton key.

Sets the multiton key.

Parameters:

key

The name of the key

Implements PureMVC::IMultitonKeyHeir.

---

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

• /Users/schell/Code/PureMVC-Plus-Plus/src/pmvcpp.h