VizKit::VisualNotificationQueue Class Reference

#include <VisualNotificationQueue.h>

List of all members.

Static Public Member Functions
static VisualNotificationQueue *	getInstance (void)
static void	dispose (void)
static void	push (VisualNotification &aNotification)
static VisualNotification	pop (void)
static size_t	size (void)
static void	update (void)
Private Types
typedef std::deque < VisualNotification >	NotificationQueue
typedef NotificationQueue::iterator	NotificationQueueIterator
Private Member Functions
	VisualNotificationQueue ()
	~VisualNotificationQueue ()
	VisualNotificationQueue (const VisualNotificationQueue &other)
VisualNotificationQueue &	operator= (const VisualNotificationQueue &other)
Private Attributes
NotificationQueue	notificationQueue
NotificationQueue	inputNotificationQueue
Static Private Attributes
static VisualNotificationQueue *	visualNotificationQueueInstance = NULL

---

Detailed Description

Queue of notifications. Singleton.

---

Member Typedef Documentation

typedef std::deque<VisualNotification> VizKit::VisualNotificationQueue::NotificationQueue [private]

A NotificationQueue is a dequeue of notifications.

Remarks:

The VisualNotificationQueue stores its events as a NotificationQueue.

typedef NotificationQueue::iterator VizKit::VisualNotificationQueue::NotificationQueueIterator [private]

A NotificationQueueIterator is an iterator of the NotificationQueue.

---

Constructor & Destructor Documentation

VisualNotificationQueue::VisualNotificationQueue

(

)

[private]

The constructor. VisualNotificationQueue is a singleton class. The constructor is private. New instance of class can only be created internally.

VisualNotificationQueue::~VisualNotificationQueue

(

)

[private]

The destructor. VisualNotificationQueue is a singleton class. The destructor is private. Instance of class can only be destructed internally.

VizKit::VisualNotificationQueue::VisualNotificationQueue

(

const VisualNotificationQueue &

other

)

[private]

Copy constructor.

Parameters:

other

Another VisualNotificationQueue.

Remarks:

Explicitely declared in private section and not implemented to enforce uniqueness of singleton pattern.

---

Member Function Documentation

void VisualNotificationQueue::dispose

(

void

)

[static]

Cleans up the VisualNotificationQueue singleton.

VisualNotificationQueue * VisualNotificationQueue::getInstance

(

void

)

[static]

Returns a pointer to the instance. Initializes the VisualNotificationQueue class if neccessary. The VisualNotificationQueue is of singleton type.

Returns:

A pointer to the initialized VisualNotificationQueue.

VisualNotificationQueue& VizKit::VisualNotificationQueue::operator=

(

const VisualNotificationQueue &

other

)

[private]

Assignment operator.

Remarks:

Explicitely declared in private section and not implemented to enforce uniqueness of singleton pattern.

VisualNotification VisualNotificationQueue::pop

(

void

)

[static]

Erases the top VisualNotification of the VisualNotificationQueue.

void VisualNotificationQueue::push

(

VisualNotification &

aNotification

)

[static]

Pushes a Notification at the end of the VisualNotificationQueue.

Parameters:

aNotification

The VisualNotification.

size_t VisualNotificationQueue::size

(

void

)

[static]

Returns the number of items currently stored in VisualNotificationQueue.

void VisualNotificationQueue::update

(

void

)

[static]

Updates the notification queue with the most recent input notifications.

---

Member Data Documentation

NotificationQueue VizKit::VisualNotificationQueue::inputNotificationQueue [private]

Input queue of notifications.

Remarks:

On push the arrived notification is stored in inputNotificationQueue to exclude concurrency conflicts with processing of notificationQueue in VisualMainAction::renderAction().

NotificationQueue VizKit::VisualNotificationQueue::notificationQueue [private]

The queue of the notifications.

VisualNotificationQueue * VisualNotificationQueue::visualNotificationQueueInstance = NULL [static, private]

VisualNotificationQueue is a singleton class. Pointer to private instance is handled internally.

---

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

• source/VisualNotificationQueue.h
• source/VisualNotificationQueue.cpp