EvaluationQueue Class Reference

A simple FIFO queue with manual removal of elements. More...

#include <EvaluationQueue.h>

Public Member Functions
wxString	GetUserLabel () const
	Query for the label the user has assigned to the current command. More...
int	GetIndex () const
void	AddEnding ()
bool	IsLastInQueue (GroupCell const *gr)
	Is GroupCell gr part of the evaluation queue?
bool	IsInQueue (GroupCell *gr) const
	Is GroupCell gr part of the evaluation queue?
void	AddToQueue (GroupCell *gr)
	Adds a GroupCell to the evaluation queue.
void	Remove (GroupCell *gr)
	Remove a GroupCell from the evaluation queue.
void	AddHiddenTreeToQueue (const GroupCell *gr)
	Adds all hidden cells attached to the GroupCell gr to the evaluation queue. More...
void	RemoveFirst ()
	Removes the first command in the queue.
GroupCell *	GetCell ()
	Gets the cell the next command in the queue belongs to. More...
bool	Empty () const
	Is the queue empty?
void	Clear ()
	Clear the queue.
wxString	GetCommand ()
	Return the next command that needs to be evaluated.
int	Size () const
	Get the size of the queue [in cells].
int	CommandsLeftInCell () const
	Get the size of the queue.

Data Fields
bool	m_workingGroupChanged = false

Detailed Description

A simple FIFO queue with manual removal of elements.

Member Function Documentation

AddHiddenTreeToQueue()

void EvaluationQueue::AddHiddenTreeToQueue

(

const GroupCell *

gr

)

Adds all hidden cells attached to the GroupCell gr to the evaluation queue.

Add the tree of hidden cells to the EQ by recursively adding cells' hidden branches to the EQ.

GetCell()

GroupCell * EvaluationQueue::GetCell

(

)

Gets the cell the next command in the queue belongs to.

The command itself can be read out by issuing GetCommand();

GetUserLabel()

wxString EvaluationQueue::GetUserLabel ( ) const

inline

Query for the label the user has assigned to the current command.

If there is no such label or the label as hidden deep down inside the command (in which case we assume the user wanted to hide it and for example didn't use it as a label at all) we return wxEmptyString.

---

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

• src/EvaluationQueue.h
• src/EvaluationQueue.cpp