org.youscope.common.microscope

Interface Property

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

FloatProperty, IntegerProperty, ReadOnlyProperty, SelectableProperty, StringProperty

public interface Property
extends java.rmi.Remote

Represents a property of a device.

Author:

langmo

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeviceID() Returns the name of the device where this property belongs to.
java.lang.String	getPropertyID() Returns the name of the device property.
PropertyType	getType() Returns the type of this device property.
java.lang.String	getValue() Returns the current value of the device property as a string.
boolean	isEditable() Returns true if property is editable and false if not.
void	setValue(java.lang.String value) Sets the current value of the property.

Method Detail

getDeviceID

java.lang.String getDeviceID()
                      throws java.rmi.RemoteException

Returns the name of the device where this property belongs to.

Returns:

Name of device.

Throws:

java.rmi.RemoteException

getPropertyID

java.lang.String getPropertyID()
                        throws java.rmi.RemoteException

Returns the name of the device property.

Returns:

Name of property.

Throws:

java.rmi.RemoteException

getType

PropertyType getType()
              throws java.rmi.RemoteException

Returns the type of this device property.

Returns:

Type of property.

Throws:

java.rmi.RemoteException

getValue

java.lang.String getValue()
                   throws java.rmi.RemoteException,
                          MicroscopeException,
                          java.lang.InterruptedException

Returns the current value of the device property as a string.

Returns:

Value of property.

Throws:

java.rmi.RemoteException

MicroscopeException

java.lang.InterruptedException

setValue

void setValue(java.lang.String value)
       throws java.rmi.RemoteException,
              MicroscopeException,
              MicroscopeLockedException,
              java.lang.InterruptedException,
              DeviceException

Sets the current value of the property. Throws a device exception if the value is not valid (i.e. if the property is an integer property and the value is not an integer), or if the property is not editable.

Parameters:

value - Value to set the property to.

Throws:

java.rmi.RemoteException

MicroscopeException

MicroscopeLockedException

java.lang.InterruptedException

DeviceException - Thrown if value does not correspond to property type.

isEditable

boolean isEditable()
            throws java.rmi.RemoteException

Returns true if property is editable and false if not.

Returns:

True if editable, otherwise false.

Throws:

java.rmi.RemoteException