OpenStudioCore:runmanager/lib
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Classes | Typedefs | Functions
openstudio::runmanager Namespace Reference

Classes

class  AddTool
 QDialog based user interface for setting RunManager configuration options. More...
 
class  AdvancedStatus
 Holds an AdvancedStatusEnum value along with an additional description. More...
 
class  AdvancedStatusEnum
 
class  ConfigOptions
 Stores configuration options for the runmanager project. More...
 
class  Configuration
 QDialog based user interface for setting RunManager configuration options. More...
 
class  ErrorEstimation
 
class  ErrorType
 
struct  FileInfo
 Basic file information class used by runmanager for handling tracking of which input and output files to and from Job objects. More...
 
class  Files
 Represents a collection of FileInfo objects. More...
 
class  FileSelection
 
class  FileSource
 
struct  FuelUse
 
struct  FuelUses
 
class  Job
 A handle to a job that must be created with the JobFactory class. More...
 
struct  JobErrors
 Holds a vector of errors and warnings descriptions generated during a job execution plus a flag indicating if the job could be considered a success regardless of errors. More...
 
class  JobErrorsDisplay
 QDialog based user interface for setting RunManager configuration options. More...
 
class  JobFactory
 Class with static methods for creating various types of Job objects. More...
 
class  JobOutputCleanup
 QDialog based user interface for allowing the use to select a set of files to clean up (delete) from a job run. More...
 
struct  JobParam
 Hierarchical list of named parameters to be used when passing advanced options to a Job The WorkflowJob currently makes use of this. More...
 
class  JobParams
 Represents a collection of JobParam. More...
 
struct  JobState
 
class  JobStatusWidget
 QDialog based user interface for displaying RunManager queue job status to the user. More...
 
class  JobType
 Enumeration of RunManager job types. More...
 
struct  JSONWorkflowOptions
 
class  LocalProcessCreator
 Implements ProcessCreator interface to create a process locally. More...
 
class  MergedJobResults
 
class  MergeJobError
 Error thrown when a merge job attempt fails. More...
 
class  NormalizeURLs
 Utility for normalizing remote and local URLs of an IDF or OSM to well defined local locations while collecting the set of moved files and making sure that no relocated files conflict. More...
 
class  Process
 Base class for local processes. More...
 
class  ProcessCreator
 Interface for Creating processes. More...
 
class  RubyJobBuilder
 Utilities class for encoding and decoding the JobParams object needed for executing a RubyJob. More...
 
class  RunManager
 A handle to an underlying RunManager_Impl object, can be copied and passed around freely. More...
 
class  RunManager_Util
 A small collection of utilities used internally by the RunManager. More...
 
class  RunManagerStatus
 QDialog based user interface for displaying RunManager queue job status to the user. More...
 
class  RunManagerStatusHandle
 Handle to a RunManagerStatus dialog when the last copy of the handle goes out of scope, the dialog is destroyed. More...
 
class  RunManagerStatusWidget
 QDialog based user interface for displaying RunManager queue job status to the user. More...
 
class  RunManagerWatcher
 
struct  ScriptDetectionError
 
struct  ScriptInfo
 
struct  SimulationDetails
 
class  SimulationEngine
 
class  SpinBoxDelegate
 Editor delegate used during editing of the ToolInfo version number. More...
 
class  ToolFinder
 Class for finding Tools installed on the local system. More...
 
struct  ToolInfo
 Used for holding details about a tool binary location. More...
 
class  ToolLocationInfo
 Contains information about a tool installation. More...
 
class  ToolNameDelegate
 Editor delegate used during editing of the ToolInfo name. More...
 
class  Tools
 Represents a collection of ToolInfo objects. More...
 
class  ToolType
 
class  ToolVersion
 Utility for holding and comparing ToolVersion numbers. More...
 
class  TreeStatusEnum
 
class  WeatherFileFinder
 Used to determine the weather file that needs to be used with a given IDF. More...
 
class  Workflow
 Utility for constructing a reproducible Job tree. More...
 
class  WorkItem
 

Typedefs

typedef boost::optional
< AdvancedStatusEnum
OptionalAdvancedStatusEnum
 
typedef boost::optional
< ErrorType
OptionalErrorType
 
typedef boost::optional
< FileSelection
OptionalFileSelection
 
typedef boost::optional
< FileSource
OptionalFileSource
 
typedef boost::optional< JobTypeOptionalJobType
 
typedef boost::optional< ToolTypeOptionalToolType
 
typedef boost::optional
< TreeStatusEnum
OptionalTreeStatusEnum
 

Functions

std::string getReportRequestMeasureArgument (const std::vector< runmanager::WorkItem > &workItems)
 gets the argument for the report request measure from a vector of work items More...
 
std::ostream & operator<< (std::ostream &os, const ErrorType &e)
 
std::ostream & operator<< (std::ostream &os, const TreeStatusEnum &e)
 
std::ostream & operator<< (std::ostream &os, const ToolType &e)
 
std::ostream & operator<< (std::ostream &os, const AdvancedStatusEnum &e)
 
std::ostream & operator<< (std::ostream &os, const ToolLocationInfo &epi)
 Operator overload for streaming ToolLocationInfo to ostream. More...
 
std::ostream & operator<< (std::ostream &os, const FileSelection &e)
 
std::ostream & operator<< (std::ostream &os, const FileSource &e)
 
std::ostream & operator<< (std::ostream &os, const JobType &e)
 
std::ostream & operator<< (std::ostream &os, const ToolVersion &tv)
 Operator overload for streaming ToolVersion to ostream. More...
 
bool saveJSON (const std::vector< WorkItem > &t_workItems, const openstudio::path &p, bool overwrite=false)
 
std::ostream & toJSON (const std::vector< WorkItem > &t_workItems, std::ostream &os)
 
std::string toJSON (const std::vector< WorkItem > &t_workItems)
 
std::vector< WorkItemtoVectorOfWorkItem (const openstudio::path &t_pathToJson)
 
std::vector< WorkItemtoVectorOfWorkItem (std::istream &t_json)
 
std::vector< WorkItemtoVectorOfWorkItem (const std::string &t_json)
 

Typedef Documentation

Function Documentation

std::string openstudio::runmanager::getReportRequestMeasureArgument ( const std::vector< runmanager::WorkItem > &  workItems)

gets the argument for the report request measure from a vector of work items

std::ostream& openstudio::runmanager::operator<< ( std::ostream &  os,
const ErrorType &  e 
)
inline
std::ostream& openstudio::runmanager::operator<< ( std::ostream &  os,
const TreeStatusEnum &  e 
)
inline
std::ostream& openstudio::runmanager::operator<< ( std::ostream &  os,
const ToolType &  e 
)
inline
std::ostream& openstudio::runmanager::operator<< ( std::ostream &  os,
const AdvancedStatusEnum &  e 
)
inline
std::ostream& openstudio::runmanager::operator<< ( std::ostream &  os,
const ToolLocationInfo &  epi 
)

Operator overload for streaming ToolLocationInfo to ostream.

std::ostream& openstudio::runmanager::operator<< ( std::ostream &  os,
const FileSelection &  e 
)
inline
std::ostream& openstudio::runmanager::operator<< ( std::ostream &  os,
const FileSource &  e 
)
inline
std::ostream& openstudio::runmanager::operator<< ( std::ostream &  os,
const JobType &  e 
)
inline
std::ostream& openstudio::runmanager::operator<< ( std::ostream &  os,
const ToolVersion &  tv 
)

Operator overload for streaming ToolVersion to ostream.

bool openstudio::runmanager::saveJSON ( const std::vector< WorkItem > &  t_workItems,
const openstudio::path &  p,
bool  overwrite = false 
)
std::ostream& openstudio::runmanager::toJSON ( const std::vector< WorkItem > &  t_workItems,
std::ostream &  os 
)
std::string openstudio::runmanager::toJSON ( const std::vector< WorkItem > &  t_workItems)
std::vector<WorkItem> openstudio::runmanager::toVectorOfWorkItem ( const openstudio::path &  t_pathToJson)
std::vector<WorkItem> openstudio::runmanager::toVectorOfWorkItem ( std::istream &  t_json)
std::vector<WorkItem> openstudio::runmanager::toVectorOfWorkItem ( const std::string &  t_json)