SimCenterCommon
Common functionality used within different SimCenter projects
Public Slots | Signals | Public Member Functions | List of all members
RemoteService Class Referenceabstract

#include <RemoteService.h>

Inheritance diagram for RemoteService:
Inheritance graph
[legend]
Collaboration diagram for RemoteService:
Collaboration graph
[legend]

Public Slots

virtual void loginCall (QString login, QString password)=0
 
virtual void logoutCall ()=0
 
virtual void mkdirCall (const QString &remoteName, const QString &remotePath)=0
 
virtual void uploadFileCall (const QString &local, const QString &remote)=0
 
virtual void downloadFilesCall (const QStringList &remote, const QStringList &local, QObject *sender=nullptr)=0
 
virtual void uploadDirectoryCall (const QString &local, const QString &remote)=0
 
virtual void removeDirectoryCall (const QString &remote)=0
 
virtual void getHomeDirPathCall (void)=0
 
virtual void startJobCall (const QJsonObject &theJob)=0
 
virtual void getJobListCall (const QString &matchingName, QString appIdFilter=QString(""))=0
 
virtual void getJobDetailsCall (const QString &jobID)=0
 
virtual void getJobStatusCall (const QString &jobID)=0
 
virtual void deleteJobCall (const QString &jobID, const QStringList &dirToRemove)=0
 
virtual void remoteLSCall (const QString &remotePath)=0
 

Signals

void statusMessage (QString)
 
void errorMessage (QString)
 
void fatalMessage (QString)
 
void loginReturn (bool ok)
 
void logoutReturn (bool ok)
 
void mkdirReturn (bool)
 
void uploadFileReturn (bool)
 
void downloadFilesReturn (bool, QObject *sender)
 
void uploadDirectoryReturn (bool)
 
void downloaDirectoryReturn (bool)
 
void removeDirectoryReturn (bool)
 
void getHomeDirPathReturn (QString)
 
void startJobReturn (QString)
 
void getJobListReturn (QJsonObject)
 
void getJobDetailsReturn (QJsonObject)
 
void getJobStatusReturn (QString)
 
void deleteJobReturn (bool)
 
void remoteLSReturn (QJsonArray dirList)
 

Public Member Functions

 RemoteService (QObject *parent=nullptr)
 
virtual ~RemoteService ()
 
virtual bool isLoggedIn ()=0
 

Detailed Description

Author
fmckenna
Date
2/2017
Version
1.0

DESCRIPTION

This is the RemoteService Interface. It provides the abstraction of the remote service. the slot methods must be implemented by the concrete subclasses. interface by interacting with the agave interface using curl calls. These are synchronnous, so the UI will appear dead while calls ongoing!

Definition at line 59 of file RemoteService.h.

Constructor & Destructor Documentation

RemoteService::RemoteService ( QObject *  parent = nullptr)
explicit

Definition at line 39 of file RemoteService.cpp.

RemoteService::~RemoteService ( )
virtual

Definition at line 45 of file RemoteService.cpp.

Member Function Documentation

virtual void RemoteService::deleteJobCall ( const QString &  jobID,
const QStringList &  dirToRemove 
)
pure virtualslot
void RemoteService::deleteJobReturn ( bool  )
signal
virtual void RemoteService::downloadFilesCall ( const QStringList &  remote,
const QStringList &  local,
QObject *  sender = nullptr 
)
pure virtualslot
void RemoteService::downloadFilesReturn ( bool  ,
QObject *  sender 
)
signal
void RemoteService::downloaDirectoryReturn ( bool  )
signal
void RemoteService::errorMessage ( QString  )
signal
void RemoteService::fatalMessage ( QString  )
signal
virtual void RemoteService::getHomeDirPathCall ( void  )
pure virtualslot
void RemoteService::getHomeDirPathReturn ( QString  )
signal
virtual void RemoteService::getJobDetailsCall ( const QString &  jobID)
pure virtualslot
void RemoteService::getJobDetailsReturn ( QJsonObject  )
signal
virtual void RemoteService::getJobListCall ( const QString &  matchingName,
QString  appIdFilter = QString("") 
)
pure virtualslot
void RemoteService::getJobListReturn ( QJsonObject  )
signal
virtual void RemoteService::getJobStatusCall ( const QString &  jobID)
pure virtualslot
void RemoteService::getJobStatusReturn ( QString  )
signal
virtual bool RemoteService::isLoggedIn ( )
pure virtual

Implemented in AgaveCurl.

virtual void RemoteService::loginCall ( QString  login,
QString  password 
)
pure virtualslot
void RemoteService::loginReturn ( bool  ok)
signal
virtual void RemoteService::logoutCall ( )
pure virtualslot
void RemoteService::logoutReturn ( bool  ok)
signal
virtual void RemoteService::mkdirCall ( const QString &  remoteName,
const QString &  remotePath 
)
pure virtualslot
void RemoteService::mkdirReturn ( bool  )
signal
virtual void RemoteService::remoteLSCall ( const QString &  remotePath)
pure virtualslot
void RemoteService::remoteLSReturn ( QJsonArray  dirList)
signal
virtual void RemoteService::removeDirectoryCall ( const QString &  remote)
pure virtualslot
void RemoteService::removeDirectoryReturn ( bool  )
signal
virtual void RemoteService::startJobCall ( const QJsonObject &  theJob)
pure virtualslot
void RemoteService::startJobReturn ( QString  )
signal
void RemoteService::statusMessage ( QString  )
signal
virtual void RemoteService::uploadDirectoryCall ( const QString &  local,
const QString &  remote 
)
pure virtualslot
void RemoteService::uploadDirectoryReturn ( bool  )
signal
virtual void RemoteService::uploadFileCall ( const QString &  local,
const QString &  remote 
)
pure virtualslot
void RemoteService::uploadFileReturn ( bool  )
signal
The documentation for this class was generated from the following files: