QueueManager Class Reference

#include <molequeue/queuemanager.h>

Inheritance diagram for QueueManager:

Public Slots
void	updateRemoteQueues () const

Signals
void	queueAdded (const QString &name, MoleQueue::Queue *queue)
void	queueRemoved (const QString &name, MoleQueue::Queue *queue)
void	queueRenamed (const QString &newName, MoleQueue::Queue *queue, const QString &oldName)

Public Member Functions
	QueueManager (Server *parentServer=0)
void	readSettings ()
void	writeSettings () const
Server *	server ()
const Server *	server () const
Queue *	lookupQueue (const QString &name) const
virtual Queue *	addQueue (const QString &queueName, const QString &queueType, bool replace=false)
bool	removeQueue (const Queue *queue)
bool	removeQueue (const QString &name)
QList< Queue * >	queues () const
QStringList	queueNames () const
int	numQueues () const
QueueListType	toQueueList () const
QString	queueConfigDirectory () const

Static Public Member Functions
static QStringList	availableQueues ()
static bool	queueTypeIsValid (const QString &queueType)

Protected Attributes
QMap< QString, Queue * >	m_queues
Server *	m_server

Detailed Description

Manage a collection of Queue instances.

Author

David C. Lonie

Member Function Documentation

server() [1/2]

Server * server

(

)

Returns

The parent Server

server() [2/2]

const Server * server

(

)

const

Returns

The parent Server

lookupQueue()

Queue * lookupQueue

(

const QString &

name

)

const

Parameters

name	String containing the name of the queue of interest.

Returns

The requested Queue, or NULL if none exist with that name.

availableQueues()

QStringList availableQueues ( )

static

Returns

A list of available queues types (e.g. PBS/Torque, SGE, etc.)

queueTypeIsValid()

bool queueTypeIsValid ( const QString & queueType )

static

Parameters

queueType

Type of Queue (SGE, PBS/Torque, Local, etc)

Returns

True if the queue can be instantiated, false otherwise.

addQueue()

virtual Queue * addQueue ( const QString & queueName, const QString & queueType, bool replace = false )

virtual

Add a new Queue to the QueueManager. The new queueName must be unique name. The QueueManager maintains ownership of the Queue.

Parameters

queueName	Unique, user-visible name of the new Queue object.
queueType	The type of the new Queue object, e.g. PBS/Torque, SGE, etc/
replace	Defaults to false; if true, replace any existing queues with the same name. The old queue with the same name will be deleted.

Returns

A pointer to the new queue if successful, NULL otherwise.

See also

queueTypeIsKnown

availableQueueTypes

removeQueue() [1/2]

bool removeQueue

(

const Queue *

queue

)

Remove and delete a queue from the collection.

Parameters

queue

Queue to remove.

Returns

True if queue exists, false otherwise.

removeQueue() [2/2]

bool removeQueue

(

const QString &

name

)

Remove and delete a queue from the collection.

Parameters

queueName

Name of queue to remove.

Returns

True if queue exists, false otherwise.

queues()

QList< Queue * > queues

(

)

const

Returns

A list of all Queue objects in the QueueManager.

queueNames()

QStringList queueNames

(

)

const

Returns

Names of all Queue objects known to the QueueManager.

numQueues()

int numQueues

(

)

const

Returns

The number of Queue objects known to the QueueManager.

toQueueList()

QueueListType toQueueList

(

)

const

Returns

A QueueListType container describing the queues and their associated programs.

queueConfigDirectory()

QString queueConfigDirectory

(

)

const

Returns

The directory path where queue configuration files are stored.

updateRemoteQueues

void updateRemoteQueues ( ) const

slot

updateRemoteQueues Request that all remote queues update the status of their jobs.

queueAdded

void queueAdded ( const QString & name, MoleQueue::Queue * queue )

signal

Emitted when a new Queue is added to the QueueManager

Parameters

name	Name of the new Queue
queue	Pointer to the Queue.

queueRemoved

void queueRemoved ( const QString & name, MoleQueue::Queue * queue )

signal

Emitted when a Queue is removed from the QueueManager

Parameters

name	Name of the new Queue
queue	Pointer to the Queue.

queueRenamed

void queueRenamed ( const QString & newName, MoleQueue::Queue * queue, const QString & oldName )

signal

queueRenamed Emitted when a queue is renamed.

---

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

• queuemanager.h