Optimization : Optimization Namespace

Visual Class

Abstract application visualization class.

public class Visual

⊟ Remarks

This class can be subclassed to visualize an optimization run by Optimization.Application. The only thing this class does is to connect to all the relevant events on Optimization.Application and provide the callbacks as virtual methods so it's easy to override them in a subclass.

⊟ Requirements

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

⊟ Members

See Also: Inherited members from object.

⊟ Public Constructors

Create new visual.

⊟ Protected Properties

[read-only]
 Application Application . The visualized application.

⊟ Public Methods

Run ()
Run visualization main loop.

⊟ Protected Methods

OnError (object, string)
Called when application fires Application.OnError.
OnIterate (object, EventArgs)
Called when application fires Application.OnIterate.
OnJob (object, Job)
Called when application fires Application.OnJob.
OnMessage (object, string)
Called when application fires Application.OnMessage.
OnProgress (object, double)
Called when application fires Application.OnProgress.
OnStatus (object, string)
Called when application fires Application.OnStatus.
OnWarning (object, string)
Called when application fires Application.OnWarning.

⊟ Member Details

⊟ Visual Constructor

Create new visual.

public Visual (Application application)

⊟ Parameters

application
The application to visualize.

⊟ Remarks

Create new visual.

⊟ Requirements

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

⊟ Application Property

The visualized application.

protected Application Application { get; }

⊟ Value

The application.

⊟ Remarks

The visualize application.

⊟ Requirements

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

⊟ OnError Method

Called when application fires Application.OnError.

protected virtual void OnError (object source, string message)

⊟ Parameters

source
Source object.
message
A message.

⊟ Remarks

Called when application fires Application.OnError.

⊟ Requirements

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

⊟ OnIterate Method

Called when application fires Application.OnIterate.

protected virtual void OnIterate (object sender, EventArgs e)

⊟ Parameters

sender
Source object.
e
Event args.

⊟ Remarks

Called when application fires Application.OnIterate.

⊟ Requirements

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

⊟ OnJob Method

Called when application fires Application.OnJob.

protected virtual void OnJob (object source, Job job)

⊟ Parameters

source
Source object.
job
Job.

⊟ Remarks

Called when application fires Application.OnJob.

⊟ Requirements

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

⊟ OnMessage Method

Called when application fires Application.OnMessage.

protected virtual void OnMessage (object source, string message)

⊟ Parameters

source
The source.
message
The message.

⊟ Remarks

Called when application fires Application.OnMessage.

⊟ Requirements

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

⊟ OnProgress Method

Called when application fires Application.OnProgress.

protected virtual void OnProgress (object source, double progress)

⊟ Parameters

source
Source object.
progress
Progress.

⊟ Remarks

Called when application fires Application.OnProgress.

⊟ Requirements

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

⊟ OnStatus Method

Called when application fires Application.OnStatus.

protected virtual void OnStatus (object source, string message)

⊟ Parameters

source
Source object.
message
Message string.

⊟ Remarks

Called when application fires Application.OnStatus.

⊟ Requirements

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

⊟ OnWarning Method

Called when application fires Application.OnWarning.

protected virtual void OnWarning (object source, string message)

⊟ Parameters

source
The source.
message
The message.

⊟ Remarks

Called when application fires Application.OnWarning.

⊟ Requirements

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

⊟ Run Method

Run visualization main loop.

public virtual void Run ()

⊟ Remarks

This is usually called just before the application is about to quit. A GUI visualizer can implement this to run their native main loop so that the GUI is kept shown after the application is done. Users might want to inspect the log for instance.

⊟ Requirements

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