org.youscope.addon.microscopeaccess

Interface MicroscopeConnectionFactory

All Known Implementing Classes:

MicroscopeConnectionFactoryImpl

public interface MicroscopeConnectionFactory

This interface is intended to be implemented by plug-ins to establish a connection to the microscope drivers.

Author:

langmo

Method Summary

Modifier and Type	Method and Description
MicroscopeInternal	createMicroscopeConnection(java.lang.String microscopeConnectionID, java.lang.String driverPath) Returns a new interface through which the drivers of the microscope can be accessed.
java.lang.String	getMicroscopeConnectionDescription(java.lang.String microscopeConnectionID) Returns a human readable description of the plug-in.
java.lang.String	getShortMicroscopeConnectionDescription(java.lang.String microscopeConnectionID) Returns a short (one line) human readable description of the plug-in.
java.lang.String[]	getSupportedMicroscopeConnectionIDs() Returns a list of all types of microscope connections the plug-in supports.
boolean	needsDriverPath(java.lang.String microscopeConnectionID) Returns true if the given connection type needs an URL to the folder where the microscope drivers are, false if such a folder is not needed.
boolean	supportsMicroscopeConnectionID(java.lang.String microscopeConnectionID) Returns true if the plug-in supports the given microscope connection type, false otherwise.

Method Detail

createMicroscopeConnection

MicroscopeInternal createMicroscopeConnection(java.lang.String microscopeConnectionID,
                                              java.lang.String driverPath)
                                       throws MicroscopeConnectionException

Returns a new interface through which the drivers of the microscope can be accessed.

Parameters:

microscopeConnectionID - The identifier of the microscope connection type.

driverPath - An URL to the local folder where the drivers are stored, or null if the respective connection type does not need such a folder.

Returns:

New microscope connection.

Throws:

MicroscopeConnectionException - Thrown if error in connecting to microManager occured.

getSupportedMicroscopeConnectionIDs

java.lang.String[] getSupportedMicroscopeConnectionIDs()

Returns a list of all types of microscope connections the plug-in supports.

Returns:

List of supported microscope connection types.

supportsMicroscopeConnectionID

boolean supportsMicroscopeConnectionID(java.lang.String microscopeConnectionID)

Returns true if the plug-in supports the given microscope connection type, false otherwise.

Parameters:

microscopeConnectionID - The identifier of the microscope connection type.

Returns:

True if the plug-in supports the given connection type, false otherwise.

needsDriverPath

boolean needsDriverPath(java.lang.String microscopeConnectionID)

Returns true if the given connection type needs an URL to the folder where the microscope drivers are, false if such a folder is not needed.

Parameters:

microscopeConnectionID - The identifier of the microscope connection type.

Returns:

True if a folder location is needed.

getMicroscopeConnectionDescription

java.lang.String getMicroscopeConnectionDescription(java.lang.String microscopeConnectionID)

Returns a human readable description of the plug-in. If a driver path is needed by this plug-in, instructions should be given to the user of how to precicely define this location.

Parameters:

microscopeConnectionID - The identifier of the microscope connection type.

Returns:

Human readable description.

getShortMicroscopeConnectionDescription

java.lang.String getShortMicroscopeConnectionDescription(java.lang.String microscopeConnectionID)

Returns a short (one line) human readable description of the plug-in.

Parameters:

microscopeConnectionID - The identifier of the microscope connection type.

Returns:

Human readable description.