VizKit  3.3.7
Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes
VizKit::VisualNotificationQueue Class Reference

Queue of notifications. More...

#include <VisualNotificationQueue.h>

List of all members.

Static Public Member Functions

static VisualNotificationQueuegetInstance (void)
 Returns a pointer to the instance.
static void dispose (void)
 Cleans up the VisualNotificationQueue singleton.
static void push (VisualNotification &aNotification)
 Pushes a Notification at the end of the VisualNotificationQueue.
static VisualNotification pop (void)
 Erases the top VisualNotification of the VisualNotificationQueue.
static size_t size (void)
 Returns the number of items currently stored in VisualNotificationQueue.
static void update (void)
 Updates the notification queue with the most recent input notifications.

Private Types

typedef std::deque
< VisualNotification
NotificationQueue
 A NotificationQueue is a dequeue of notifications.
typedef NotificationQueue::iterator NotificationQueueIterator
 A NotificationQueueIterator is an iterator of the NotificationQueue.

Private Member Functions

 VisualNotificationQueue ()
 The constructor.
 ~VisualNotificationQueue ()
 The destructor.
 VisualNotificationQueue (const VisualNotificationQueue &other)
 Copy constructor.
VisualNotificationQueueoperator= (const VisualNotificationQueue &other)
 Assignment operator.

Private Attributes

NotificationQueue notificationQueue
 The queue of the notifications.
NotificationQueue inputNotificationQueue
 Input queue of notifications.

Static Private Attributes

static VisualNotificationQueuevisualNotificationQueueInstance = NULL
 VisualNotificationQueue is a singleton class.

Detailed Description

Queue of notifications.

Singleton.


Member Typedef Documentation

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

The constructor.

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

The destructor.

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

Copy constructor.

Parameters:
otherAnother 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.

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.
void VisualNotificationQueue::push ( VisualNotification aNotification) [static]

Pushes a Notification at the end of the VisualNotificationQueue.

Parameters:
aNotificationThe 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

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().

The queue of the notifications.

VisualNotificationQueue is a singleton class.

Pointer to private instance is handled internally.


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

Generated on Sun May 3 2015 20:26:32 for VizKit by doxygen 1.8.0