org.youscope.addon.microscopeaccess

Interface PropertyInternal

All Known Subinterfaces:

FloatPropertyInternal, IntegerPropertyInternal, ReadOnlyPropertyInternal, SelectablePropertyInternal, StringPropertyInternal

All Known Implementing Classes:

PropertyImpl

public interface PropertyInternal

Represents a property of a device.

Author:

langmo

Property Summary

Type	Property and Description
boolean	isPreInitialization Gets the value of the property preInitializationProperty.

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.
boolean	isPreInitializationProperty() Gets the value of the property preInitializationProperty.
void	setValue(java.lang.String value, int accessID) Sets the current value of the property.

Property Detail

isPreInitialization

boolean isPreInitializationProperty

Gets the value of the property preInitializationProperty.

Method Detail

getDeviceID

java.lang.String getDeviceID()

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

Returns:

Name of device.

getPropertyID

java.lang.String getPropertyID()

Returns the name of the device property.

Returns:

Name of property.

getType

PropertyType getType()

Returns the type of this device property.

Returns:

Type of property.

getValue

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

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

Returns:

Value of property.

Throws:

MicroscopeException

java.lang.InterruptedException

setValue

void setValue(java.lang.String value,
              int accessID)
       throws 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.

accessID - The access ID of the current microscope object. If the microscope is locked with a different accessID, a MicroscopeLockedException is thrown.

Throws:

MicroscopeException

MicroscopeLockedException

java.lang.InterruptedException

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

isEditable

boolean isEditable()

Returns true if property is editable and false if not.

Returns:

True if editable, otherwise false.

isPreInitializationProperty

boolean isPreInitializationProperty()

Gets the value of the property preInitializationProperty.