org.eclipse.eavp.viz.service.visit.connections

Class VisItConnection

java.lang.Object

org.eclipse.eavp.viz.service.connections.VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

org.eclipse.eavp.viz.service.visit.connections.VisItConnection

All Implemented Interfaces:

IVizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

public class VisItConnection
extends VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

This class provides an IVizConnection for connecting to VisItSwtConnections.

Author:

Jordan Deyton

Constructor Summary

Constructors

Constructor and Description
VisItConnection() The default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets a description of the connection.
java.lang.String	getHost() Gets the current host associated with the connection.
java.lang.String	getName() Gets the name of the connection.
int	getNextWindowId() Gets the next available window ID from the underlying connection.
java.lang.String	getPath() Gets the installation path to the executable required to run the associated connection widget.
int	getPort() Gets the port associated with the connection.
boolean	setDescription(java.lang.String description) Sets the description of the connection.
boolean	setHost(java.lang.String host) Sets the host for the connection.
boolean	setName(java.lang.String name) Sets the name of the connection.
boolean	setPath(java.lang.String path) Sets the path of the connection.
boolean	setPort(int port) Sets the port of the connection.

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

addListener, connect, disconnect, getProperties, getProperty, getState, getStatusMessage, getWidget, removeListener, setProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

VisItConnection

public VisItConnection()

The default constructor.

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: IVizConnection

Gets a description of the connection. This should be a string that can be displayed to the user.

Specified by:

getDescription in interface IVizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Overrides:

getDescription in class VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Returns:

A description of the connection. Should not be null, but may be an empty string.

getHost

public java.lang.String getHost()

Description copied from interface: IVizConnection

Gets the current host associated with the connection. For local connections, this will be "localhost".

Specified by:

getHost in interface IVizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Overrides:

getHost in class VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Returns:

The current host. This value should never be null.

getName

public java.lang.String getName()

Description copied from interface: IVizConnection

Gets the name of the connection. This name should be unique within its associated VizConnectionManager.

Specified by:

getName in interface IVizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Overrides:

getName in class VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Returns:

The (unique) name of the connection.

getNextWindowId

public int getNextWindowId()

Gets the next available window ID from the underlying connection. Each unique, disjoint view powered by VisIt requires a separate "window" in VisIt. Views that share a window ID will be updated concurrently.

Returns:

The next available window ID, or -1 if the connection is not open.

getPath

public java.lang.String getPath()

Description copied from interface: IVizConnection

Gets the installation path to the executable required to run the associated connection widget. This should be a full path formatted to the host machine's operating system.

Specified by:

getPath in interface IVizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Overrides:

getPath in class VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Returns:

The installation path to the visualization engine on the host machine.

getPort

public int getPort()

Description copied from interface: IVizConnection

Gets the port associated with the connection. This is the port at which the associated connection widget hosts the viz rendering service.

Specified by:

getPort in interface IVizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Overrides:

getPort in class VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Returns:

The connection's port.

setDescription

public boolean setDescription(java.lang.String description)

Description copied from class: VizConnection

Sets the description of the connection. This is a convenient method that can be used instead of VizConnection.setProperty(String, String).

Overrides:

setDescription in class VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Parameters:

description - The new description of the property.

Returns:

True if the description was changed, false otherwise.

setHost

public boolean setHost(java.lang.String host)

Description copied from class: VizConnection

Sets the host for the connection. This is a convenient method that can be used instead of VizConnection.setProperty(String, String).

Overrides:

setHost in class VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Parameters:

host - The host name of the property.

Returns:

True if the host was changed, false otherwise.

setName

public boolean setName(java.lang.String name)

Description copied from class: VizConnection

Sets the name of the connection. This is a convenient method that can be used instead of VizConnection.setProperty(String, String).

Overrides:

setName in class VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Parameters:

name - The new name of the property.

Returns:

True if the name was changed, false otherwise.

setPath

public boolean setPath(java.lang.String path)

Description copied from class: VizConnection

Sets the path of the connection. This is a convenient method that can be used instead of VizConnection.setProperty(String, String).

Overrides:

setPath in class VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Parameters:

path - The new path of the property.

Returns:

True if the path was changed, false otherwise.

setPort

public boolean setPort(int port)

Description copied from class: VizConnection

Sets the port of the connection. This is a convenient method that can be used instead of VizConnection.setProperty(String, String).

Overrides:

setPort in class VizConnection<gov.lbnl.visit.swt.VisItSwtConnection>

Parameters:

port - The new port of the property.

Returns:

True if the port was changed, false otherwise.