openstudio::runmanager::WorkItem Class Reference

#include <WorkItem.hpp>

Public Member Functions
std::string	toJSON () const
Constructors
	WorkItem ()
	WorkItem (openstudio::runmanager::JobType t_type)
	WorkItem (openstudio::runmanager::JobType t_type, const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::string &t_jobkeyname="")
Getters and Queries
bool	operator== (const WorkItem &t_rhs) const
boost::optional < FileReferenceType >	inputFileType () const
	Returns the type of the primary input file for this work item. More...
boost::optional < FileReferenceType >	outputFileType () const
	Returns the type of the primary output file for this work item. More...

Static Public Member Functions
static WorkItem	fromJSON (const std::string &t_json)
static openstudio::LogChannel	logChannel ()

Public Attributes
openstudio::runmanager::Files	files
std::string	jobkeyname
openstudio::runmanager::JobParams	params
openstudio::runmanager::Tools	tools
openstudio::runmanager::JobType	type

Constructor & Destructor Documentation

openstudio::runmanager::WorkItem::WorkItem

(

)

openstudio::runmanager::WorkItem::WorkItem

(

openstudio::runmanager::JobType

t_type

)

openstudio::runmanager::WorkItem::WorkItem	(	openstudio::runmanager::JobType	t_type,
		const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::string &	t_jobkeyname = ""
	)

Member Function Documentation

static WorkItem openstudio::runmanager::WorkItem::fromJSON ( const std::string &  t_json )

static

Returns

WorkItem represented by the given JSON strong

Exceptions

std::exception

with description if something goes wrong

boost::optional<FileReferenceType> openstudio::runmanager::WorkItem::inputFileType

(

)

const

Returns the type of the primary input file for this work item.

Generally used to keep track of the energy model type (OSM, IDF) at various points in a workflow.

static openstudio::LogChannel openstudio::runmanager::WorkItem::logChannel ( )

inlinestatic

bool openstudio::runmanager::WorkItem::operator==

(

const WorkItem &

t_rhs

)

const

boost::optional<FileReferenceType> openstudio::runmanager::WorkItem::outputFileType

(

)

const

Returns the type of the primary output file for this work item.

Generally used to keep track of the energy model type (OSM, IDF) at various points in a workflow.

std::string openstudio::runmanager::WorkItem::toJSON

(

)

const

Returns

a JSON representation of this WorkItem

This is the prefered method of transferring Workflow components over a network and between computers.

See also

openstudio::runmanager::Job::toJSON for more advanced methods of persisting and transferring Worfklow objects

Member Data Documentation

openstudio::runmanager::Files openstudio::runmanager::WorkItem::files

std::string openstudio::runmanager::WorkItem::jobkeyname

openstudio::runmanager::JobParams openstudio::runmanager::WorkItem::params

openstudio::runmanager::Tools openstudio::runmanager::WorkItem::tools

openstudio::runmanager::JobType openstudio::runmanager::WorkItem::type