orxonox::Notification Class Reference

A Notification represents a short message used to inform the player about something that just happened. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/modules/notifications/NotificationManager.h>

Public Member Functions
	Notification (const std::string &message, const std::string &sender, NotificationMessageType type)
	Constructor. More...
virtual	~Notification ()
	Destructor. More...
void	destroy (void)
	Destroys the Notification. More...
const std::string &	getMessage (void) const
	Get the message of the Notification. More...
const std::string &	getSender (void) const
	Get the sender of the Notification. More...
NotificationMessageType	getType (void) const
	Get the type of the Notification. More...

Private Member Functions
void	initialize (void)
	Registers the object and sets some default values. More...

Private Attributes
std::string	message_
	The Notification message. More...
std::string	sender_
	The sender of the notification. More...
NotificationMessageType	type_
	The type of the notification. More...

Detailed Description

A Notification represents a short message used to inform the player about something that just happened.

With the NotificationManager a Notification can be sent from any part of orxonox and is then displayed by the proper NotificationQueue(s) (depending on which senders the specific NotificationQueues accepts).

A Notification is just a data structure that is used internally by the Notifications module.

Author

Damian 'Mozork' Frick

Constructor & Destructor Documentation

orxonox::Notification::Notification	(	const std::string &	message,
		const std::string &	sender,
		NotificationMessageType	type
	)

Constructor.

Creates a Notification with the input message and sender.

Parameters

message	The message of the Notification.
sender	The sender of the Notification.
type

orxonox::Notification::~Notification ( )

virtual

Destructor.

Member Function Documentation

void orxonox::Notification::destroy ( void  )

inline

Destroys the Notification.

const std::string& orxonox::Notification::getMessage ( void  ) const

inline

Get the message of the Notification.

Returns

Returns the message of the Notification.

const std::string& orxonox::Notification::getSender ( void  ) const

inline

Get the sender of the Notification.

Returns

Returns the sender of the Notification.

NotificationMessageType orxonox::Notification::getType ( void  ) const

inline

Get the type of the Notification.

Returns

Returns an enum with the type of the Notification.

void orxonox::Notification::initialize ( void  )

private

Registers the object and sets some default values.

Member Data Documentation

std::string orxonox::Notification::message_

private

The Notification message.

std::string orxonox::Notification::sender_

private

The sender of the notification.

NotificationMessageType orxonox::Notification::type_

private

The type of the notification.

---

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

• modules/notifications/NotificationManager.h
• modules/notifications/NotificationManager.cc