QueueUit Class Reference

#include <queueuit.h>

Inheritance diagram for QueueUit:

Public Slots
void	requestQueueUpdate ()
Public Slots inherited from QueueRemote
bool	submitJob (MoleQueue::Job job)
void	killJob (MoleQueue::Job job)
virtual void	requestQueueUpdate ()=0
Public Slots inherited from Queue
virtual bool	submitJob (MoleQueue::Job job)=0
virtual void	killJob (MoleQueue::Job job)=0
virtual void	setLaunchTemplate (const QString &script)
virtual void	setLaunchScriptName (const QString &scriptName)

Signals
void	uitMethodError (const QString &errorString)
void	userHostAssocList (const Uit::UserHostAssocList &list)
Signals inherited from Queue
void	programAdded (const QString &name, MoleQueue::Program *program)
void	programRemoved (const QString &name, MoleQueue::Program *program)
void	programRenamed (const QString &newName, Program *prog, const QString &oldName)
void	nameChanged (const QString &newName, const QString &oldName)

Public Member Functions
	QueueUit (QueueManager *parentManager=0)
virtual QString	typeName () const
bool	writeJsonSettings (QJsonObject &json, bool exportOnly, bool includePrograms) const
bool	readJsonSettings (const QJsonObject &json, bool importOnly, bool includePrograms)
AbstractQueueSettingsWidget *	settingsWidget ()
QString	kerberosUserName ()
void	setKerberosUserName (const QString &userName)
QString	kerberosRealm ()
void	setKerberosRealm (const QString &realm)
QString	hostName () const
void	setHostName (const QString &host)
qint64	hostId ()
void	setHostID (qint64 id)
bool	testConnection (QWidget *parentObject)
Public Member Functions inherited from QueueRemote
	QueueRemote (const QString &queueName="AbstractRemote", QueueManager *parentManager=0)
void	setWorkingDirectoryBase (const QString &base)
QString	workingDirectoryBase () const
void	setQueueUpdateInterval (int i)
int	queueUpdateInterval () const
void	setDefaultMaxWallTime (int time)
int	defaultMaxWallTime () const
void	replaceKeywords (QString &launchScript, const Job &job, bool addNewline=true)
Public Member Functions inherited from Queue
Server *	server ()
const Server *	server () const
QueueManager *	queueManager ()
const QueueManager *	queueManager () const
virtual void	setName (const QString &newName)
QString	name () const
bool	readSettings (const QString &filePath)
bool	writeSettings () const
bool	exportSettings (const QString &fileName, bool includePrograms=true) const
bool	importSettings (const QString &fileName, bool includePrograms=true)
QString	stateFileName () const
bool	addProgram (Program *newProgram, bool replace=false)
bool	removeProgram (Program *programToRemove)
bool	removeProgram (const QString &programName)
Program *	lookupProgram (const QString &programName) const
QStringList	programNames () const
QList< Program * >	programs () const
int	numPrograms () const
virtual QString	launchTemplate () const
QString	launchScriptName () const
int	jobFailureCount (IdType moleQueueId) const

Static Public Attributes
static const QString	clientId

Protected Slots
void	createRemoteDirectory (MoleQueue::Job job)
void	createRemoteDirectoryError (const QString &errorString)
void	remoteDirectoryCreated ()
void	copyInputFilesToHost (MoleQueue::Job job)
void	copyInputFilesToHostError (const QString &erroString)
void	inputFilesCopied ()
void	uploadInputFilesToHost (Job job)
void	processStatFileRequest ()
void	submitJobToRemoteQueue (MoleQueue::Job job)
void	jobSubmittedToRemoteQueue ()
void	jobSubmissionError (const QString &errorString)
void	handleQueueUpdate ()
void	handleQueueUpdate (const QList< Uit::JobEvent > &jobEvents)
void	requestQueueUpdateError (const QString &)
void	beginFinalizeJob (MoleQueue::IdType queueId)
void	finalizeJobCopyFromServer (MoleQueue::Job job)
void	finalizeJobOutputCopiedFromServer ()
void	finalizeJobCopyFromServerError (const QString &errorString)
void	finalizeJobCopyToCustomDestination (MoleQueue::Job job)
void	finalizeJobCleanup (MoleQueue::Job job)
void	cleanRemoteDirectory (MoleQueue::Job job)
void	cleanRemoteDirectoryError (const QString &errorString)
void	remoteDirectoryCleaned ()
void	beginKillJob (MoleQueue::Job job)
void	killJobError (const QString &errorString)
void	endKillJob ()
void	testConnectionComplete (const QString &token)
void	testConnectionError (const QString &errorMessage)
Protected Slots inherited from QueueRemote
virtual void	submitPendingJobs ()
virtual void	beginJobSubmission (MoleQueue::Job job)
virtual void	createRemoteDirectory (MoleQueue::Job job)=0
virtual void	remoteDirectoryCreated ()=0
virtual void	copyInputFilesToHost (MoleQueue::Job job)=0
virtual void	inputFilesCopied ()=0
virtual void	submitJobToRemoteQueue (MoleQueue::Job job)=0
virtual void	jobSubmittedToRemoteQueue ()=0
virtual void	handleQueueUpdate ()=0
virtual void	beginFinalizeJob (MoleQueue::IdType queueId)=0
virtual void	finalizeJobCopyFromServer (MoleQueue::Job job)=0
virtual void	finalizeJobOutputCopiedFromServer ()=0
virtual void	finalizeJobCopyToCustomDestination (MoleQueue::Job job)=0
virtual void	finalizeJobCleanup (MoleQueue::Job job)
virtual void	cleanRemoteDirectory (MoleQueue::Job job)=0
virtual void	remoteDirectoryCleaned ()=0
void	jobAboutToBeRemoved (const MoleQueue::Job &job)
virtual void	beginKillJob (MoleQueue::Job job)=0
virtual void	endKillJob ()=0
Protected Slots inherited from Queue
virtual void	jobAboutToBeRemoved (const MoleQueue::Job &job)
void	programNameChanged (const QString &newName, const QString &oldName)
void	cleanLocalDirectory (const MoleQueue::Job &job)

Additional Inherited Members
Static Public Member Functions inherited from Queue
static QString	queueTypeFromFile (const QString &mqqFile)
Protected Member Functions inherited from QueueRemote
virtual void	removeStaleJobs ()
virtual void	timerEvent (QTimerEvent *theEvent)
Protected Member Functions inherited from Queue
	Queue (const QString &queueName="Undefined", QueueManager *parentManager=0)
bool	writeInputFiles (const Job &job)
bool	addJobFailure (IdType moleQueueId)
void	clearJobFailures (IdType moleQueueId)
Protected Attributes inherited from QueueRemote
int	m_checkQueueTimerId
QList< IdType >	m_pendingSubmission
int	m_checkForPendingJobsTimerId
int	m_queueUpdateInterval
int	m_defaultMaxWallTime
QString	m_workingDirectoryBase
Protected Attributes inherited from Queue
QueueManager *	m_queueManager
Server *	m_server
QString	m_name
QString	m_launchTemplate
QString	m_launchScriptName
QMap< QString, Program * >	m_programs
QMap< IdType, IdType >	m_jobs
QMap< IdType, int >	m_failureTracker

Detailed Description

QueueRemote subclass for interacting with a remote queue over UIT.

Member Function Documentation

typeName()

virtual QString typeName ( ) const

virtual

Returns the type of the queue as a string.

Reimplemented from Queue.

writeJsonSettings()

bool writeJsonSettings ( QJsonObject & value, bool exportOnly, bool includePrograms ) const

virtual

writeJsonSettings Write the queue's internal state into a JSON object.

Parameters

value	Target JSON object.
exportOnly	If true, instance specific information (e.g. currently running jobs, login details, etc) is omitted.
includePrograms	Whether or not to include the Queue's program configurations.

Returns

True on success, false on failure.

Reimplemented from QueueRemote.

readJsonSettings()

bool readJsonSettings ( const QJsonObject & value, bool importOnly, bool includePrograms )

virtual

readJsonSettings Initialize the queue's internal state from a JSON object.

Parameters

value	Source JSON object.
importOnly	If true, instance specific information (e.g. currently running jobs, login details, etc) is ignored.
includePrograms	Whether or not to include the Queue's program configurations.

Returns

True on success, false on failure.

Note

When reimplementing this method, verify and parse the Json object into temporary variables, then call the base class implementation and only modify the queue if the call returns true.

Reimplemented from QueueRemote.

settingsWidget()

AbstractQueueSettingsWidget * settingsWidget ( )

virtual

Returns a widget that can be used to configure the settings for the queue.

Implements QueueRemote.

kerberosUserName()

QString kerberosUserName

(

)

Returns

The Kerberos username.

setKerberosUserName()

void setKerberosUserName

(

const QString &

userName

)

Set the Kereros username.

kerberosRealm()

QString kerberosRealm

(

)

Returns

The Kerberos realm.

setKerberosRealm()

void setKerberosRealm

(

const QString &

realm

)

Set the Kerberos realm.

testConnection()

bool testConnection

(

QWidget *

parentObject

)

Test the connection to UIT.

testConnectionComplete

void testConnectionComplete ( const QString & token )

protectedslot

Called when test authentication is complete

Parameters

The	session token.

testConnectionError

void testConnectionError ( const QString & errorMessage )

protectedslot

Called when test authentication produces an error

Parameters

The	error message.

---

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

• queueuit.h