#include <JobFactory.hpp>

Static Public Member Functions
static Job	createBasementJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a BasementJob, generic version. More...

static Job	createCalculateEconomicsJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a CalculateEconomicsJob, generic version. More...

static Job	createDakotaJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a DakotaJob, generic version. More...

static Job	createEnergyPlusJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create an EnergyPlusJob, generic version. More...

static Job	createEnergyPlusJob (openstudio::runmanager::ToolInfo t_energyPlusTool, const openstudio::path &t_idd, const openstudio::path &t_idf, const openstudio::path &t_epw, const openstudio::path &t_outdir, const boost::optional< openstudio::UUID > &t_uuid=createUUID())
	Create an EnergyPlusJob. More...

static Job	createEnergyPlusJob (const openstudio::runmanager::Tools &t_tools, const openstudio::path &t_idd, const openstudio::path &t_idf, const openstudio::path &t_epw, const openstudio::path &t_outdir, const boost::optional< openstudio::UUID > &t_uuid=createUUID())
	Create an EnergyPlusJob. More...

static Job	createEnergyPlusJob (const std::string &t_filename)
	Creates an EnergyPlusJob with the filename to pull from the list of provided inherited FileInfo objects specified. More...

static Job	createEnergyPlusPostProcessJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a EnergyPlusPostProcessJob, generic version. More...

static Job	createEnergyPlusPreProcessJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a EnergyPlusPreProcessJob, generic version. More...

static Job	createExpandObjectsJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create an ExpandObjectsJob, generic version. More...

static Job	createIdfToModelJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a IdfToModelJob, generic version. More...

static Job	createIdfToModelJob (const openstudio::path &t_idf, const openstudio::path &t_outdir, const boost::optional< openstudio::UUID > &t_uuid=createUUID())
	Create a IdfToModelJob. More...

static Job	createJob (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::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a generically defined job using the parameters passed in Can be useful by things like WorkflowJob which can create a list of user specified jobs. More...

static Job	createModelToIdfJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a ModelToIdfJob, generic version. More...

static Job	createModelToIdfJob (const openstudio::path &t_model, const openstudio::path &t_outdir, const boost::optional< openstudio::UUID > &t_uuid=createUUID())
	Create a ModelToIdfJob. More...

static Job	createModelToRadJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a ModelToRadJob, generic version. More...

static Job	createModelToRadJob (const openstudio::path &t_model, const openstudio::path &t_sql, const openstudio::path &t_outdir, const boost::optional< openstudio::UUID > &t_uuid=createUUID())
	Create a ModelToIdfJob. More...

static Job	createModelToRadPreProcessJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a ModelToRadPreProcessJob, generic version. More...

static Job	createNullJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a NullJob, generic version. More...

static Job	createNullJob (const boost::optional< openstudio::UUID > &t_uuid=createUUID())
	Creates a NullJob. More...

static Job	createOpenStudioPostProcessJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a OpenStudioPostProcessJob, generic version. More...

static Job	createParallelEnergyPlusJobTree (int t_numSplits, int t_offset)
	Creates a Parallel EnergyPlus job tree consisting of the split job, N child jobs and a join finishedJob. More...

static Job	createParallelEnergyPlusJoinJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a ParallelEnergyPlusJoinJob, generic version. More...

static Job	createParallelEnergyPlusJoinJob (int t_numSplits, int t_offset)
	Create a ParallelEnergyPlusJoinJob, with the expected number of jobs to join. More...

static Job	createParallelEnergyPlusSplitJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a ParallelEnergyPlusSplitJob, generic version. More...

static Job	createParallelEnergyPlusSplitJob (int t_numSplits, int t_offset)
	Create a ParallelEnergyPlusSplitJob, with the number of jobs to split. More...

static Job	createPreviewIESJob (const openstudio::path &t_ies, const openstudio::path &t_outdir, const boost::optional< openstudio::UUID > &t_uuid=createUUID())
	Creates a PreviewIESJob. More...

static Job	createPreviewIESJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a PreviewIESJob, generic version. More...

static Job	createReadVarsJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a ReadVarsJob, generic version. More...

static Job	createRubyJob (const openstudio::path &t_rubyfile, const std::string &t_infileregex, const openstudio::path &t_outdir, const boost::optional< openstudio::UUID > &t_uuid=createUUID())
	Create a RubyJob. More...

static Job	createRubyJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a RubyJob, generic version. More...

static Job	createRubyJob (const openstudio::runmanager::RubyJobBuilder &t_builder, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID())

static Job	createSlabJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a SlabJob, generic version. More...

static Job	createUserScriptJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create a UserScriptJob, generic version. More...

static Job	createUserScriptJob (const openstudio::path &t_rubyfile, const std::vector< ruleset::OSArgument > &t_args, const boost::optional< openstudio::UUID > &t_uuid=createUUID())
	Create a UserScriptJob, generic version. More...

static Job	createXMLPreprocessorJob (const openstudio::runmanager::Tools &t_tools, const openstudio::runmanager::JobParams &t_params, const openstudio::runmanager::Files &t_files, const std::vector< openstudio::URLSearchPath > &t_url_search_paths=std::vector< openstudio::URLSearchPath >(), bool t_loading=false, const boost::optional< openstudio::UUID > &t_uuid=createUUID(), const openstudio::runmanager::JobState &t_state=JobState())
	Create an XMLPreprocessorJob, generic version. More...

static void	optimizeJobTree (openstudio::runmanager::Job t_job)
	Merges all jobs which may be merged together. More...

Detailed Description

Class with static methods for creating various types of Job objects.

A Job can be created either with a specific method, or with the generically defined "createJob."

See also: Job Types

Member Function Documentation

static Job openstudio::runmanager::JobFactory::createBasementJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a BasementJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: Basement Job

static Job openstudio::runmanager::JobFactory::createCalculateEconomicsJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a CalculateEconomicsJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: CalculateEconomics Job

static Job openstudio::runmanager::JobFactory::createDakotaJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a DakotaJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

static Job openstudio::runmanager::JobFactory::createEnergyPlusJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create an EnergyPlusJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: EnergyPlus Job

static Job openstudio::runmanager::JobFactory::createEnergyPlusJob	(	openstudio::runmanager::ToolInfo	t_energyPlusTool,
		const openstudio::path &	t_idd,
		const openstudio::path &	t_idf,
		const openstudio::path &	t_epw,
		const openstudio::path &	t_outdir,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`
	)

static

Create an EnergyPlusJob.

Parameters

[in]	t_energyPlusTool	ToolInfo representing where to find energyplus
[in]	t_idd	Location to idd file to use
[in]	t_idf	Location to idf to simulate
[in]	t_epw	Location to epw file to use during simulation
[in]	t_outdir	Location to use during simulation
[in]	t_uuid	Option to specify the UUID of the job.

See also: EnergyPlus Job

static Job openstudio::runmanager::JobFactory::createEnergyPlusJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::path &	t_idd,
		const openstudio::path &	t_idf,
		const openstudio::path &	t_epw,
		const openstudio::path &	t_outdir,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`
	)

static

Create an EnergyPlusJob.

Parameters

[in]	t_tools	Set of tools to use during simulation. Should contain at least one EnegyPlus tool.
[in]	t_idd	Location to idd file to use
[in]	t_idf	Location to idf to simulate
[in]	t_epw	Location to epw file to use during simulation
[in]	t_outdir	Location to use during simulation
[in]	t_uuid	Option to specify the UUID of the job.

See also: EnergyPlus Job

static Job openstudio::runmanager::JobFactory::createEnergyPlusJob ( const std::string & t_filename )

static

Creates an EnergyPlusJob with the filename to pull from the list of provided inherited FileInfo objects specified.

Parameters

[in] t_filename Filename for the EnergyPlus job to look for at job execution time

static Job openstudio::runmanager::JobFactory::createEnergyPlusPostProcessJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a EnergyPlusPostProcessJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: EnergyPlusPostProcess Job

static Job openstudio::runmanager::JobFactory::createEnergyPlusPreProcessJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a EnergyPlusPreProcessJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: EnergyPlusPreProcess Job

static Job openstudio::runmanager::JobFactory::createExpandObjectsJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create an ExpandObjectsJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: ExpandObjects Job

static Job openstudio::runmanager::JobFactory::createIdfToModelJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a IdfToModelJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

static Job openstudio::runmanager::JobFactory::createIdfToModelJob	(	const openstudio::path &	t_idf,
		const openstudio::path &	t_outdir,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`
	)

static

Create a IdfToModelJob.

Parameters

[in]	t_idf	Path to IDF
[in]	t_outdir	Path to place generated out.osm file in
[in]	t_uuid	Option to specify the UUID of the job.

See also: ModelToIdf Job

static Job openstudio::runmanager::JobFactory::createJob	(	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::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a generically defined job using the parameters passed in Can be useful by things like WorkflowJob which can create a list of user specified jobs.

Also used during loading of the RunManager database file

Parameters

[in]	t_type	The job type to create. See JobType enumeration
[in]	t_tools	A vector of ToolInfo objects for all known/used tools. The job specific code finds and uses the ToolInfo objects that are needed for the specific job.
[in]	t_params	Named hierarchical parameter list that Job parameters are extracted from
[in]	t_files	Vector of FileInfo objects the specific job can choose from.
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If loading from a db and you do not want to perform any fixing up, set to true
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: Job Types

static Job openstudio::runmanager::JobFactory::createModelToIdfJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a ModelToIdfJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: ModelToIdf Job

static Job openstudio::runmanager::JobFactory::createModelToIdfJob	(	const openstudio::path &	t_model,
		const openstudio::path &	t_outdir,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`
	)

static

Create a ModelToIdfJob.

Parameters

[in]	t_model	Path to OSM file
[in]	t_outdir	Path to place generated out.idf file in
[in]	t_uuid	Option to specify the UUID of the job.

See also: ModelToIdf Job

static Job openstudio::runmanager::JobFactory::createModelToRadJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a ModelToRadJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: ModelToRad Job

static Job openstudio::runmanager::JobFactory::createModelToRadJob	(	const openstudio::path &	t_model,
		const openstudio::path &	t_sql,
		const openstudio::path &	t_outdir,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`
	)

static

Create a ModelToIdfJob.

Parameters

[in]	t_model	Path to OSM file
[in]	t_sql	Path to SQL simulation file from previous EnergyPlus run
[in]	t_outdir	Path to place generated out.idf file in
[in]	t_uuid	Option to specify the UUID of the job.

See also: ModelToRad Job

static Job openstudio::runmanager::JobFactory::createModelToRadPreProcessJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a ModelToRadPreProcessJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: ModelToRadPreProcess Job

static Job openstudio::runmanager::JobFactory::createNullJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a NullJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: Null Job

static Job openstudio::runmanager::JobFactory::createNullJob ( const boost::optional< openstudio::UUID > & t_uuid = createUUID() )

static

Creates a NullJob.

Parameters

[in] t_uuid Option to specify the UUID of the job.

See also: Null Job

static Job openstudio::runmanager::JobFactory::createOpenStudioPostProcessJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a OpenStudioPostProcessJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: OpenStudioPostProcess Job

static Job openstudio::runmanager::JobFactory::createParallelEnergyPlusJobTree	(	int	t_numSplits,
		int	t_offset
	)

static

Creates a Parallel EnergyPlus job tree consisting of the split job, N child jobs and a join finishedJob.

Parameters

[in]	t_numSplits	number of splits to create
[in]	t_offset	number of days to precalculate

See also: ParallelEnergyPlusSplit Job; ParallelEnergyPlusJoin Job

static Job openstudio::runmanager::JobFactory::createParallelEnergyPlusJoinJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a ParallelEnergyPlusJoinJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: ParallelEnergyPlusJoin Job

static Job openstudio::runmanager::JobFactory::createParallelEnergyPlusJoinJob	(	int	t_numSplits,
		int	t_offset
	)

static

Create a ParallelEnergyPlusJoinJob, with the expected number of jobs to join.

Parameters

[in]	t_numSplits	number of splits to join
[in]	t_offset	number of days to precalculate

See also: ParallelEnergyPlusJoin Job

static Job openstudio::runmanager::JobFactory::createParallelEnergyPlusSplitJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a ParallelEnergyPlusSplitJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: ParallelEnergyPlusSplit Job

static Job openstudio::runmanager::JobFactory::createParallelEnergyPlusSplitJob	(	int	t_numSplits,
		int	t_offset
	)

static

Create a ParallelEnergyPlusSplitJob, with the number of jobs to split.

Parameters

[in]	t_numSplits	number of splits to create
[in]	t_offset	number of days to precalculate

See also: ParallelEnergyPlusSplit Job

static Job openstudio::runmanager::JobFactory::createPreviewIESJob	(	const openstudio::path &	t_ies,
		const openstudio::path &	t_outdir,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`
	)

static

Creates a PreviewIESJob.

Parameters

[in]	t_ies	Path to input IES file
[in]	t_outdir	Directory to create TIFF / BMP in
[in]	t_uuid	Option to specify the UUID of the job.

See also: PreviewIES Job

static Job openstudio::runmanager::JobFactory::createPreviewIESJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a PreviewIESJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: PreviewIES Job

static Job openstudio::runmanager::JobFactory::createReadVarsJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a ReadVarsJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: ReadVars Job

static Job openstudio::runmanager::JobFactory::createRubyJob	(	const openstudio::path &	t_rubyfile,
		const std::string &	t_infileregex,
		const openstudio::path &	t_outdir,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`
	)

static

Create a RubyJob.

this version assumes that a parent job has already provided the ToolInfo for the ruby executable

Parameters

[in]	t_rubyfile	Ruby file to execute
[in]	t_infileregex	Regular expression indicating which input files are requirements for the job
[in]	t_outdir	Output directory to use during simulation.
[in]	t_uuid	Option to specify the UUID of the job.

See also: Ruby Job

static Job openstudio::runmanager::JobFactory::createRubyJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a RubyJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: Ruby Job

static Job openstudio::runmanager::JobFactory::createRubyJob	(	const openstudio::runmanager::RubyJobBuilder &	t_builder,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`
	)

static

static Job openstudio::runmanager::JobFactory::createSlabJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a SlabJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: Slab Job

static Job openstudio::runmanager::JobFactory::createUserScriptJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create a UserScriptJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: Ruby Job

static Job openstudio::runmanager::JobFactory::createUserScriptJob	(	const openstudio::path &	t_rubyfile,
		const std::vector< ruleset::OSArgument > &	t_args,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`
	)

static

Create a UserScriptJob, generic version.

Parameters

[in]	t_rubyfile	UserScript ruby file to execute
[in]	t_args	Arguments to pass to the UserScript job
[in]	t_uuid	Option to specify the UUID of the job.

See also: Ruby Job

static Job openstudio::runmanager::JobFactory::createXMLPreprocessorJob	(	const openstudio::runmanager::Tools &	t_tools,
		const openstudio::runmanager::JobParams &	t_params,
		const openstudio::runmanager::Files &	t_files,
		const std::vector< openstudio::URLSearchPath > &	t_url_search_paths = `std::vector< openstudio::URLSearchPath >()`,
		bool	t_loading = `false`,
		const boost::optional< openstudio::UUID > &	t_uuid = `createUUID()`,
		const openstudio::runmanager::JobState &	t_state = `JobState()`
	)

static

Create an XMLPreprocessorJob, generic version.

Parameters

[in]	t_tools	Tools to pass in
[in]	t_params	JobParams to pass in
[in]	t_files	Files to pass in
[in]	t_url_search_paths	Vector of paths to search when fixing up URLs in an IDF or OSM
[in]	t_loading	If true, skip fixing up of URLs, used when loading RunManager database file.
[in]	t_uuid	Option to specify the UUID of the job.
[in]	t_state	Option to restore state.

See also: XMLPreprocessor Job

static void openstudio::runmanager::JobFactory::optimizeJobTree ( openstudio::runmanager::Job t_job )

static

Merges all jobs which may be merged together.

This includes eliminating Null jobs where possible. Additional merge behavior is job type specific.

Static Public Member Functions

Detailed Description

Member Function Documentation