org.eclipse.eavp.viz.service.paraview

Class ParaViewVizService

java.lang.Object

org.eclipse.eavp.viz.service.AbstractVizService

org.eclipse.eavp.viz.service.connections.ConnectionVizService<IParaViewWebClient>

org.eclipse.eavp.viz.service.paraview.ParaViewVizService

All Implemented Interfaces:

IVizService

public class ParaViewVizService
extends ConnectionVizService<IParaViewWebClient>

This class is responsible for providing a service to connect to (or launch) either local or remote instances of ParaView. Additionally, it can be used to create ParaViewPlots that can render files supported by ParaView within an SWT-based application.

Author:

Jordan Deyton

See Also:

ParaViewPlot

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONNECTIONS_NODE_ID The ID of the preferences node under which all connections will be added.
static java.lang.String	PREFERENCE_PAGE_ID The ID of the preferences page.

Constructor Summary

Constructors

Constructor and Description
ParaViewVizService() The default constructor.

Method Summary

Modifier and Type	Method and Description
IVizCanvas	createCanvas(Geometry geometry) This operation directs the IVizService to create a new canvas displaying the given Geometry and to return a handle to that canvas to the caller so that it may modify the canvas.
IControllerProviderFactory	getControllerProviderFactory() Returns a factory which will create views and controllers for model parts specific to the service's rendering program.
java.lang.String	getName() This operation returns the name of the service.
java.lang.String	getVersion() This operation returns a version number for the service.

Methods inherited from class org.eclipse.eavp.viz.service.connections.ConnectionVizService

createPlot

Methods inherited from class org.eclipse.eavp.viz.service.AbstractVizService

createCanvas, getSupportedExtensions

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONNECTIONS_NODE_ID

public static final java.lang.String CONNECTIONS_NODE_ID

The ID of the preferences node under which all connections will be added.

See Also:

Constant Field Values

PREFERENCE_PAGE_ID

public static final java.lang.String PREFERENCE_PAGE_ID

The ID of the preferences page.

See Also:

Constant Field Values

Constructor Detail

ParaViewVizService

public ParaViewVizService()

The default constructor.

Note: Only OSGi should call this method!

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IVizService

This operation returns the name of the service. The name should be something simple and human-readable.

Returns:

The name of the IVizService

getVersion

public java.lang.String getVersion()

Description copied from interface: IVizService

This operation returns a version number for the service. It should be more or less human readable and contain a major and a minor version (Version 2.1 instead of just 2, for example).

Returns:

The version of the IVizService

getControllerProviderFactory

public IControllerProviderFactory getControllerProviderFactory()

Description copied from interface: IVizService

Returns a factory which will create views and controllers for model parts specific to the service's rendering program.

Returns:

A factory that will create controllers compatible with this service

createCanvas

public IVizCanvas createCanvas(Geometry geometry)
                        throws java.lang.Exception

Description copied from interface: IVizService

This operation directs the IVizService to create a new canvas displaying the given Geometry and to return a handle to that canvas to the caller so that it may modify the canvas.

Parameters:

geometry - The input object which will be rendered in the new canvas.

Returns:

The IVizCanvas that will render the object

Throws:

java.lang.Exception - An exception indicating that the IVizService could not create a canvas with the given object and giving the reason why.