SimCenterCommon
Common functionality used within different SimCenter projects
SimCenterAppWidget Class Reference

#include <SimCenterAppWidget.h>

Inheritance diagram for SimCenterAppWidget:
Collaboration diagram for SimCenterAppWidget:

Public Member Functions

 SimCenterAppWidget (QWidget *parent=0)
 
virtual ~SimCenterAppWidget ()
 
virtual bool outputAppDataToJSON (QJsonObject &jsonObject)
 outputAppDataToJSON method to write the application data to json object. More...
 
virtual bool inputAppDataFromJSON (QJsonObject &jsonObject)
 inputFromJSON method to read applications specific data from a JSON object More...
 
virtual bool copyFiles (QString &destDir)
 copyFiles method invoked to copy all files aapplication will need to run directory More...
 
virtual bool supportsLocalRun ()
 returns a boolean indicating whether or not this app can run locally More...
 
- Public Member Functions inherited from SimCenterWidget
 SimCenterWidget (QWidget *parent=0)
 
virtual ~SimCenterWidget ()
 
virtual bool outputToJSON (QJsonObject &jsonObject)
 outputToJSON method to write all objects data neeed to reconstruct object to JsonObject More...
 
virtual bool inputFromJSON (QJsonObject &jsonObject)
 inputFromJSON method to instantiate itself from a JSON object More...
 

Static Public Member Functions

static bool copyPath (QString sourceDir, QString destinationDir, bool overWriteDirectory)
 
static bool copyFile (QString filename, QString destinationDir)
 

Additional Inherited Members

- Signals inherited from SimCenterWidget
void sendFatalMessage (QString message)
 sendFatalMessage signal to be emitted when object needs to shut program down More...
 
void sendErrorMessage (QString message)
 sendErrorMessage signal to be emitted when object needs to communicate error with user More...
 
void sendStatusMessage (QString message)
 sendStatusMessage signal to be emitted when object needs to communicate status with user More...
 

Detailed Description

Definition at line 55 of file SimCenterAppWidget.h.

Constructor & Destructor Documentation

SimCenterAppWidget::SimCenterAppWidget ( QWidget *  parent = 0)
explicit

Definition at line 43 of file SimCenterAppWidget.cpp.

SimCenterAppWidget::~SimCenterAppWidget ( )
virtual

Definition at line 49 of file SimCenterAppWidget.cpp.

Member Function Documentation

bool SimCenterAppWidget::copyFile ( QString  filename,
QString  destinationDir 
)
static

Definition at line 128 of file SimCenterAppWidget.cpp.

bool SimCenterAppWidget::copyFiles ( QString &  destDir)
virtual

copyFiles method invoked to copy all files aapplication will need to run directory

Parameters
destDirthe directory to put files in
Returns
bool - true for success, otherwise false

Reimplemented in ExistingSimCenterEvents, UQ_EngineSelection, MDOF_BuildingModel, OpenSeesBuildingModel, FEM_Selection, BIM_Selection, UserDefinedEDP, SIM_Selection, StandardEarthquakeEDP, InputWidgetExistingEvent, InputWidgetOpenSeesAnalysis, EDP_EarthquakeSelection, EDP_Selection, and UserDefinedApplication.

Definition at line 71 of file SimCenterAppWidget.cpp.

bool SimCenterAppWidget::copyPath ( QString  sourceDir,
QString  destinationDir,
bool  overWriteDirectory 
)
static

Possible race-condition mitigation?

Definition at line 83 of file SimCenterAppWidget.cpp.

bool SimCenterAppWidget::inputAppDataFromJSON ( QJsonObject &  jsonObject)
virtual

inputFromJSON method to read applications specific data from a JSON object

Parameters
rvObjectthe JSON object contaiing data to instantiate the object
Returns
bool - true for success, otherwise false

Reimplemented in ExistingSimCenterEvents, InputWidgetSampling, UQ_EngineSelection, MDOF_BuildingModel, DakotaInputSampling, OpenSeesBuildingModel, UserDefinedEDP, SIM_Selection, StandardEarthquakeEDP, InputWidgetExistingEvent, FEM_Selection, BIM_Selection, DakotaEngine, InputWidgetOpenSeesAnalysis, EDP_EarthquakeSelection, EDP_Selection, and UserDefinedApplication.

Definition at line 63 of file SimCenterAppWidget.cpp.

bool SimCenterAppWidget::outputAppDataToJSON ( QJsonObject &  jsonObject)
virtual

outputAppDataToJSON method to write the application data to json object.

Parameters
rvObjectthe JSON object to be written to
Returns
bool - true for success, otherwise false

Reimplemented in ExistingSimCenterEvents, InputWidgetSampling, UQ_EngineSelection, MDOF_BuildingModel, DakotaInputSampling, OpenSeesBuildingModel, UserDefinedEDP, SIM_Selection, StandardEarthquakeEDP, InputWidgetExistingEvent, FEM_Selection, BIM_Selection, DakotaEngine, InputWidgetOpenSeesAnalysis, EDP_EarthquakeSelection, EDP_Selection, and UserDefinedApplication.

Definition at line 56 of file SimCenterAppWidget.cpp.

bool SimCenterAppWidget::supportsLocalRun ( )
virtual

returns a boolean indicating whether or not this app can run locally

Returns
bool - true means the app can run locally, otherwise false

Definition at line 77 of file SimCenterAppWidget.cpp.


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