Class Job

A job object defines one simulation (E+ config and replacement data).

Inheritance

System.Object

Job

Namespace: EplusLauncher

Assembly: cs.temp.dll.dll

Syntax

public class Job

Constructors

Job(Configuration)

Creates a new job with a certain configuration.

Declaration

public Job(Configuration config)

Parameters

Type	Name	Description
Configuration	config	Job main configuration.

Properties

Cleaner

If a job has a cleaner instance, the cleaning will be performed after the job has finished.

Declaration

public Cleaner Cleaner { get; set; }

Property Value

Type	Description
Cleaner

Config

Job configuration object.

Declaration

public Configuration Config { get; set; }

Property Value

Type	Description
Configuration

OutputFolder

Path to the folder where simulation outputs will be generated.

Declaration

public string OutputFolder { get; set; }

Property Value

Type	Description
System.String	Output folder.

Methods

AddTags(String[])

Sets the list of search tags to be replaced.

Declaration

public void AddTags(params string[] searchTags)

Parameters

Type	Name	Description
System.String[]	searchTags	Search tags.

AddValues(Double[])

Sets the list of values that will replace the search tags.

Declaration

public void AddValues(params double[] values)

Parameters

Type	Name	Description
System.Double[]	values	Values to replace search tags.

AddValues(Object[])

Sets the list of values that will replace the search tags.

Declaration

public void AddValues(params object[] values)

Parameters

Type	Name	Description
System.Object[]	values	Values to replace search tags.

Clear()

Clears previously set Tags and Values.

Declaration

public void Clear()

Clone()

Clones a job object, including its configuration.

Declaration

public Job Clone()

Returns

Type	Description
Job	Cloned job.

Run()

Runs the simulation job.

Declaration

public void Run()

Set(String, Double)

Assigns a value to an existing search tag or adds a new Tag/Value pair.

Declaration

public void Set(string tag, double value)

Parameters

Type	Name	Description
System.String	tag	Search tag
System.Double	value	New value.

Set(String, String)

Assigns a value to an existing search tag or adds a new Tag/Value pair.

Declaration

public void Set(string tag, string value)

Parameters

Type	Name	Description
System.String	tag	Search tag
System.String	value	New value.