OpenTwin 0.1
OpenTwin
 
Loading...
Searching...
No Matches
ot::SimpleQueue Class Reference

#include "Queue.h"

Inheritance diagram for ot::SimpleQueue:

Public Member Functions

 SimpleQueue ()
 
virtual ~SimpleQueue ()
 
virtual void queue (QueueObject *_obj, QueueData *_arg=(QueueData *) nullptr) noexcept override
 Add the provided object to the queue.
 
virtual void queueNext (QueueObject *_obj, QueueData *_arg=(QueueData *) nullptr) noexcept override
 Add the provided object to the front of the queue.
 
virtual bool executeQueue (void) override
 Execute the queue.
 
void clearQueue (void)
 Clear the queue.
 

Protected Member Functions

void checkAndDestroy (QueueDestroyableObject *_obj)
 Will clear the memory according to the objects cleanup flags.
 

Constructor & Destructor Documentation

◆ SimpleQueue()

ot::SimpleQueue::SimpleQueue ( )

◆ ~SimpleQueue()

ot::SimpleQueue::~SimpleQueue ( )
virtual

Member Function Documentation

◆ checkAndDestroy()

void ot::SimpleQueue::checkAndDestroy ( QueueDestroyableObject * _obj)
protected

Will clear the memory according to the objects cleanup flags.

Note
Note that the provided object might be destroyed after calling this function

◆ clearQueue()

void ot::SimpleQueue::clearQueue ( void )

Clear the queue.

◆ executeQueue()

bool ot::SimpleQueue::executeQueue ( void )
overridevirtual

Execute the queue.

◆ queue()

void ot::SimpleQueue::queue ( QueueObject * _obj,
QueueData * _arg = (QueueData*)nullptr )
overridevirtualnoexcept

Add the provided object to the queue.

Parameters
_objThe object to add to the queue
_argThe arguments object that will be passed to the objects activate call

◆ queueNext()

void ot::SimpleQueue::queueNext ( QueueObject * _obj,
QueueData * _arg = (QueueData*)nullptr )
overridevirtualnoexcept

Add the provided object to the front of the queue.

Parameters
_objThe object to add to the queue
_argThe arguments object that will be passed to the objects activate call

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