SimCenter Agave Client Interface  0.0.0
This repo is to be used for other SimCenter Projects which communicate with an Agave server.
Public Slots | Signals | Public Member Functions | List of all members
RemoteDataInterface Class Referenceabstract

The RemoteDataInterface is an abstract class for communicating with a remote file and job server over an https connection. More...

Public Slots

virtual QString getUserName ()=0
 After login, getUserName will return the name of the user logged in.
 
virtual RemoteDataReplycloseAllConnections ()=0
 
virtual RemoteDataReplyperformAuth (QString uname, QString passwd)=0
 
virtual RemoteDataReplyremoteLS (QString dirPath)=0
 
virtual RemoteDataReplydeleteFile (QString toDelete)=0
 
virtual RemoteDataReplymoveFile (QString from, QString to)=0
 
virtual RemoteDataReplycopyFile (QString from, QString to)=0
 
virtual RemoteDataReplyrenameFile (QString fullName, QString newName)=0
 
virtual RemoteDataReplymkRemoteDir (QString location, QString newName)=0
 
virtual RemoteDataReplyuploadFile (QString location, QString localFileName)=0
 
virtual RemoteDataReplyuploadBuffer (QString location, QByteArray fileData, QString newFileName)=0
 
virtual RemoteDataReplydownloadFile (QString localDest, QString remoteName)=0
 
virtual RemoteDataReplydownloadBuffer (QString remoteName)=0
 
virtual RemoteDataReplyrunRemoteJob (QString jobName, ParamMap jobParameters, QString remoteWorkingDir, QString indivJobName="", QString archivePath="")=0
 
virtual RemoteDataReplygetListOfJobs ()=0
 
virtual RemoteDataReplygetJobDetails (QString IDstr)=0
 
virtual RemoteDataReplystopJob (QString IDstr)=0
 
virtual RemoteDataReplydeleteJob (QString IDstr)=0
 
virtual RemoteDataInterfaceState getInterfaceState ()=0
 
static QString interpretRequestState (RequestState theState)
 
static QString removeDoubleSlashes (QString stringIn)
 

Signals

void connectionStateChanged (RemoteDataInterfaceState newState)
 

Public Member Functions

 RemoteDataInterface (QObject *parent=nullptr)
 Brief Constructor description. Brief Constructor description continued. More...
 

Detailed Description

The RemoteDataInterface is an abstract class for communicating with a remote file and job server over an https connection.

This class is intended to be subclassed for actual use. At present, the AgaveHandler class is the only subclass available. If the SimCenter project is required to used a different file or computing backend, a new subclass will have to be written.

The performAuth method should be invoked before any of the methods requiring remote access. The closeAllConnections will disconnect from the remote server. RemoteDataInterface objects are designed to be one use. To re-login, destroy the old object and create a new one.

Constructor & Destructor Documentation

RemoteDataInterface::RemoteDataInterface ( QObject *  parent = nullptr)

Brief Constructor description. Brief Constructor description continued.

Detailed Constructor description starts here.