Optimization : Optimization.Storage Namespace

Storage Class

Abstract optimization results storage.

public class Storage

⊟ Remarks

Abstract class for storing optimization results. You can subclass this and implement/override the relevant functions to save results in altnernative formats.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ Members

See Also: Inherited members from object.

⊟ Public Constructors

Documentation for this section has not yet been entered.

⊟ Public Properties

[read-only]
 Job Job . Documentation for this section has not yet been entered.
[read-only]
 UnixTimeStamp long . Documentation for this section has not yet been entered.
Uri string . Uri where data should be saved.

⊟ Public Methods

Begin ()
Begin optimization.
Close ()
Documentation for this section has not yet been entered.
End ()
End optimization.
Log (string, string)
Log a message.
Open () : bool
Documentation for this section has not yet been entered.
Query (string, params object[]) : bool
Documentation for this section has not yet been entered.
Query (string, Optimization.Storage.Storage.RowCallback, params object[]) : bool
Documentation for this section has not yet been entered.
QueryFirst (string, params object[]) : object[]
Documentation for this section has not yet been entered.
QueryValue (string, params object[]) : object
Documentation for this section has not yet been entered.
ReadIteration (int) : Optimization.Storage.Records.Iteration
Documentation for this section has not yet been entered.
ReadIterations () : long
Documentation for this section has not yet been entered.
ReadJob () : Optimization.Storage.Records.Job
Documentation for this section has not yet been entered.
ReadLog () : List<Optimization.Storage.Records.Log>
Documentation for this section has not yet been entered.
ReadSolution (int, int) : Optimization.Storage.Records.Solution
Documentation for this section has not yet been entered.
ReadSolutions (long) : long
Documentation for this section has not yet been entered.
SaveActiveParameters ()
Documentation for this section has not yet been entered.
SaveIteration ()
Save current iteration.
SaveSettings ()
Documentation for this section has not yet been entered.
SaveToken ()
Documentation for this section has not yet been entered.

⊟ Public Operators

static
Conversion to System.Boolean (Implicit) Documentation for this section has not yet been entered.

⊟ Member Details

⊟ Storage Constructor

Documentation for this section has not yet been entered.

public Storage (Optimization.Job job)

⊟ Parameters

job
Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ Begin Method

Begin optimization.

public void Begin ()

⊟ Remarks

Called when the optimization is started.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ Close Method

Documentation for this section has not yet been entered.

public void Close ()

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ End Method

End optimization.

public void End ()

⊟ Remarks

Called when the optimization is finished.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ Job Property

Documentation for this section has not yet been entered.

public Optimization.Job Job { get; }

⊟ Value

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ Log Method

Log a message.

public void Log (string type, string str)

⊟ Parameters

type
Log type.
str
Log message.

⊟ Remarks

Called when a message should be logged. The log is mainly used as a way for the user to look back and see if there where any problems at some point.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ Conversion Method

Documentation for this section has not yet been entered.

public static implicit operator bool (Storage s)

⊟ Parameters

s
Documentation for this section has not yet been entered.

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ Open Method

Documentation for this section has not yet been entered.

public bool Open ()

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ Query Method

Documentation for this section has not yet been entered.

public bool Query (string s, params object[] parameters)

⊟ Parameters

s
Documentation for this section has not yet been entered.
parameters
Documentation for this section has not yet been entered.

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ Query Method

Documentation for this section has not yet been entered.

public bool Query (string s, Storage.RowCallback cb, params object[] parameters)

⊟ Parameters

s
Documentation for this section has not yet been entered.
cb
Documentation for this section has not yet been entered.
parameters
Documentation for this section has not yet been entered.

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ QueryFirst Method

Documentation for this section has not yet been entered.

public object[] QueryFirst (string s, params object[] parameters)

⊟ Parameters

s
Documentation for this section has not yet been entered.
parameters
Documentation for this section has not yet been entered.

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ QueryValue Method

Documentation for this section has not yet been entered.

public object QueryValue (string s, params object[] parameters)

⊟ Parameters

s
Documentation for this section has not yet been entered.
parameters
Documentation for this section has not yet been entered.

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ ReadIteration Method

Documentation for this section has not yet been entered.

public Optimization.Storage.Records.Iteration ReadIteration (int iteration)

⊟ Parameters

iteration
Documentation for this section has not yet been entered.

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ ReadIterations Method

Documentation for this section has not yet been entered.

public long ReadIterations ()

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ ReadJob Method

Documentation for this section has not yet been entered.

public Optimization.Storage.Records.Job ReadJob ()

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ ReadLog Method

Documentation for this section has not yet been entered.

public List<Optimization.Storage.Records.Log> ReadLog ()

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ ReadSolution Method

Documentation for this section has not yet been entered.

public Optimization.Storage.Records.Solution ReadSolution (int iteration, int id)

⊟ Parameters

iteration
Documentation for this section has not yet been entered.
id
Documentation for this section has not yet been entered.

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ ReadSolutions Method

Documentation for this section has not yet been entered.

public long ReadSolutions (long iteration)

⊟ Parameters

iteration
Documentation for this section has not yet been entered.

⊟ Returns

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ SaveActiveParameters Method

Documentation for this section has not yet been entered.

public void SaveActiveParameters ()

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ SaveIteration Method

Save current iteration.

public void SaveIteration ()

⊟ Remarks

Called when the current iteration of the optimiation should be saved.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ SaveSettings Method

Documentation for this section has not yet been entered.

public void SaveSettings ()

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ SaveToken Method

Documentation for this section has not yet been entered.

public void SaveToken ()

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ UnixTimeStamp Property

Documentation for this section has not yet been entered.

public long UnixTimeStamp { get; }

⊟ Value

Documentation for this section has not yet been entered.

⊟ Remarks

Documentation for this section has not yet been entered.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)

⊟ Uri Property

Uri where data should be saved.

public string Uri { set; get; }

⊟ Value

An uri.

⊟ Remarks

Get or set the uri at which data should be saved.

⊟ Requirements

Namespace: Optimization.Storage
Assembly: Optimization (in Optimization.dll)