Information about a particular job.
This class contains all the information on a particular job. This includes the optimizer to use, the name of the dispatcher and the dispatcher settings (Optimization.Dispatcher) and optionally what token the job should use.
A job can be loaded from a simple XML specification listing which optimizer to use, what are the boundaries and parameters for optimization and the dispatcher settings.
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
See Also: Inherited members from object.
⊟ Public Constructors
Create new job. ⊟ Public Properties
[read-only] Dispatcher Job.Dispatch . The dispatcher. [read-only] Name string . Job name. Optimizer Optimizer . The optimizer. Priority double . The job priority. [read-only] SynchronousStorage bool . Synchronous storage. Timeout double . Timeout. Token string . The job token. [read-only] User string . The job user. ⊟ Public Methods
FromXml (string) : Job Load a job from an XML string.Initialize () Initialize the job.LoadFromStorage (string) : bool Load job from storage.NewFromXml (string) : Job Create new job from xml.
⊟ Job Constructor
Create new job.
public Job ()⊟ Remarks
Create new job.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ Dispatcher Property
The dispatcher.
public Job.Dispatch Dispatcher { get; }⊟ Value
The dispatcher.⊟ Remarks
The dispatcher to use for this job.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ FromXml Method
Load a job from an XML string.
⊟ Parameters
- xml
- XML string.
⊟ Returns
A new job.⊟ Remarks
Load a job from an XML string.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ Initialize Method
Initialize the job.
public void Initialize ()⊟ Remarks
Initializing the job will initialize the optimizer which in turn will initialize the storage and will create the initial optimizer population.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ LoadFromStorage Method
Load job from storage.
⊟ Parameters
- filename
- The filename.
⊟ Returns
Whether the job was successfully loaded from storage.⊟ Remarks
Load job from storage.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ Name Property
Job name.
public string Name { get; }⊟ Value
Job name.⊟ Remarks
Get the job name. The job name is usually used to build the file where the optimization results are stored.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ NewFromXml Method
Create new job from xml.
⊟ Parameters
- filename
- Filename.
⊟ Returns
A new job.⊟ Remarks
Create a new job from an xml definition.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ Optimizer Property
The optimizer.
public Optimizer Optimizer { set; get; }⊟ Value
The optimizer.⊟ Remarks
The optimizer used in this job.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ Priority Property
The job priority.
public double Priority { set; get; }⊟ Value
The priority.⊟ Remarks
The priority under which the job should be scheduled and executed by the master.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ SynchronousStorage Property
Synchronous storage.
public bool SynchronousStorage { get; }⊟ Value
Whether synchronous storage is enabled.⊟ Remarks
Get whether synchronous storage is enabled. Synchronous storage relates to the sqlite .⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ Timeout Property
Timeout.
public double Timeout { set; get; }⊟ Value
Timeout.⊟ Remarks
Specify the job timeout.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ Token Property
The job token.
public string Token { set; get; }⊟ Value
The token.⊟ Remarks
The token with which the job can be authenticated.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)
⊟ User Property
The job user.
public string User { get; }⊟ Value
The job user.⊟ Remarks
Get the job user. This normally defaults to the username of the user executing a job.⊟ Requirements
Namespace: Optimization
Assembly: Optimization (in Optimization.dll)