SpikeStream Application Library  0.2
spikestream::Globals Class Reference

#include <Globals.h>

List of all members.

Static Public Member Functions

static bool archiveLoaded ()
static void cleanUp ()
static void clearAnalysisRunning (const QString &analysisName)
static unsigned int getAnalysisID (const QString &analysisName)
static AnalysisDao * getAnalysisDao ()
static Archive * getArchive ()
static ArchiveDao * getArchiveDao ()
static EventRoutergetEventRouter ()
static Network * getNetwork ()
static NetworkDao * getNetworkDao ()
static NetworkDisplaygetNetworkDisplay ()
static AbstractSimulationgetSimulation ()
static QString getSpikeStreamRoot ()
static QString getWorkingDirectory ()
static bool isAnalysisRunning ()
static bool isArchivePlaying ()
static bool isAnalysisLoaded (const QString &analysisName)
static bool isSimulationLoaded ()
static bool isSimulationRunning ()
static bool isRendering ()
static bool networkChangeOk ()
static bool networkLoaded ()
static void setAnalysisID (const QString &analysisName, unsigned int id)
static void setAnalysisRunning (const QString &analysisName)
static void setArchivePlaying (bool archivePlaying)
static void setNetwork (Network *network)
static void setSimulation (AbstractSimulation *simulation)
static void setSimulationLoading (bool simulationLoading)
static void setSimulationRunning (bool simulationRunning)

Friends

class SpikeStreamMainWindow
class spikestream::NetworksWidget
class spikestream::NetworkViewer
class spikestream::ArchiveWidget

Detailed Description

Definition at line 24 of file Globals.h.


Member Function Documentation

bool Globals::archiveLoaded ( ) [static]

Returns true if an archive is loaded. Should always check with this method before requesting the archive because it will be null if it is not loaded.

Definition at line 78 of file Globals.cpp.

void Globals::cleanUp ( ) [static]

Cleans up all classes stored in Globals. Everything stored in Globals is deleted by Globals.

Definition at line 87 of file Globals.cpp.

void Globals::clearAnalysisRunning ( const QString &  analysisName) [static]

Clears the running state for a particular analysis

Definition at line 37 of file Globals.cpp.

AnalysisDao * Globals::getAnalysisDao ( ) [static]

Returns the analysis Dao that wraps the SpikeStreamAnalysis database.

Definition at line 118 of file Globals.cpp.

unsigned int Globals::getAnalysisID ( const QString &  analysisName) [static]

Returns the analysis id if it has been set, otherwise return zero

Definition at line 66 of file Globals.cpp.

Archive * Globals::getArchive ( ) [static]

Returns the current archive

Definition at line 124 of file Globals.cpp.

ArchiveDao * Globals::getArchiveDao ( ) [static]

Returns the archive dao, which provides a layer of abstraction on top of the SpikeStreamArchive database

Definition at line 133 of file Globals.cpp.

static EventRouter* spikestream::Globals::getEventRouter ( ) [inline, static]

Definition at line 33 of file Globals.h.

Network * Globals::getNetwork ( ) [static]

Returns the current network

Definition at line 139 of file Globals.cpp.

NetworkDao * Globals::getNetworkDao ( ) [static]

Returns the network dao, which provides a layer of abstraction on top of the SpikeStreamNetwork database

Definition at line 148 of file Globals.cpp.

Returns the network display.

Definition at line 154 of file Globals.cpp.

Returns the simulation

Definition at line 160 of file Globals.cpp.

QString Globals::getSpikeStreamRoot ( ) [static]

Returns the root directory where SpikeStream is installed.

Definition at line 166 of file Globals.cpp.

QString Globals::getWorkingDirectory ( ) [static]

Returns the working directory which is opened when loading projects, import files etc.

Definition at line 172 of file Globals.cpp.

bool Globals::isAnalysisLoaded ( const QString &  analysisName) [static]

Returns true if an analysis is loaded

Definition at line 43 of file Globals.cpp.

bool Globals::isAnalysisRunning ( ) [static]

Returns true if any analysis is running

Definition at line 57 of file Globals.cpp.

bool Globals::isArchivePlaying ( ) [static]

Returns true if archive playback is in progress

Definition at line 192 of file Globals.cpp.

bool Globals::isRendering ( ) [static]

Returns true if OpenGL rendering is in progress

Definition at line 186 of file Globals.cpp.

bool Globals::isSimulationLoaded ( ) [static]

Returns true if a simulation is being loaded

Definition at line 198 of file Globals.cpp.

bool Globals::isSimulationRunning ( ) [static]

Returns true if a simulation is running

Definition at line 206 of file Globals.cpp.

bool Globals::networkChangeOk ( ) [static]

Runs checks when a network is loaded and the user attempts to load a different network or delete the current network. If a simulation or analysis is running, the user is requested to stop them and try again. If a simulation is loaded, confirmation is requested from the user. True is returned if everything is ok.

Definition at line 214 of file Globals.cpp.

bool Globals::networkLoaded ( ) [static]

Returns true if a network is loaded, false if no network exists.

Definition at line 178 of file Globals.cpp.

void Globals::setAnalysisID ( const QString &  analysisName,
unsigned int  id 
) [static]

Sets the analysis id. An id of 0 indicates that no analysis is loaded.

Definition at line 249 of file Globals.cpp.

void Globals::setAnalysisRunning ( const QString &  analysisName) [static]

Records that a particular analysis is running

Definition at line 255 of file Globals.cpp.

void Globals::setArchivePlaying ( bool  archivePlaying) [static]

Sets whether archive playback is taking place

Definition at line 302 of file Globals.cpp.

void Globals::setNetwork ( Network *  net) [static]

Sets the network

Definition at line 318 of file Globals.cpp.

void Globals::setSimulation ( AbstractSimulation simulation) [static]

Sets the simulation. It is the caller's responsibilty to delete the simulation.

Definition at line 357 of file Globals.cpp.

static void spikestream::Globals::setSimulationLoading ( bool  simulationLoading) [static]
void Globals::setSimulationRunning ( bool  simulationRunning) [static]

Sets the simulation running state

Definition at line 261 of file Globals.cpp.


Friends And Related Function Documentation

friend class spikestream::ArchiveWidget [friend]

Definition at line 61 of file Globals.h.

friend class spikestream::NetworksWidget [friend]

Definition at line 59 of file Globals.h.

friend class spikestream::NetworkViewer [friend]

Definition at line 60 of file Globals.h.

friend class SpikeStreamMainWindow [friend]

Definition at line 58 of file Globals.h.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Typedefs Friends Defines