org.youscope.common.microscope

Class DeviceSetting

java.lang.Object

org.youscope.common.microscope.DeviceSetting

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DeviceSetting
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Setting for a device property.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeviceSetting() Default constructor.
DeviceSetting(DeviceSetting deviceSetting) Clone constructor.
DeviceSetting(java.lang.String device, java.lang.String property, float value) Constructor already initializing the setting.
DeviceSetting(java.lang.String device, java.lang.String property, int value) Constructor already initializing the setting.
DeviceSetting(java.lang.String device, java.lang.String property, java.lang.String value) Constructor already initializing the setting.

Method Summary

Modifier and Type	Method and Description
DeviceSetting	clone()
boolean	equals(java.lang.Object obj)
java.lang.String	getDevice() Returns the device of which a property should be changed.
float	getFloatValue() Returns the value of the setting as a float.
int	getIntegerValue() Returns the value of the setting as an integer.
java.lang.String	getProperty() Returns the property of the device which should be changed.
java.lang.String	getStringValue() Returns the value of the setting as a string.
int	hashCode()
boolean	isAbsoluteValue() Returns true if the property should be set to the given value, and false if it should be changed for an offset relative to the current value.
void	setAbsoluteValue(boolean absoluteValue) Set to true if the property should be set to the given value, and to false if it should be changed for an offset relative to the current value.
void	setDeviceProperty(java.lang.String device, java.lang.String property) Sets the device property which this setting represents.
void	setRelativeValue(float offset) Sets the current value of the setting relative to its previous value.
void	setRelativeValue(int offset) Sets the current value of the setting relative to its previous value.
void	setValue(float value) Sets the current value of the setting.
void	setValue(int value) Sets the current value of the setting.
void	setValue(java.lang.String value) Sets the current value of the setting.
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeviceSetting

public DeviceSetting()

Default constructor.

DeviceSetting

public DeviceSetting(java.lang.String device,
                     java.lang.String property,
                     java.lang.String value)

Constructor already initializing the setting.

Parameters:

device - the device to set.

property - the property to set.

value - the value to set.

DeviceSetting

public DeviceSetting(java.lang.String device,
                     java.lang.String property,
                     int value)

Constructor already initializing the setting.

Parameters:

device - the device to set.

property - the property to set.

value - the value to set.

DeviceSetting

public DeviceSetting(java.lang.String device,
                     java.lang.String property,
                     float value)

Constructor already initializing the setting.

Parameters:

device - the device to set.

property - the property to set.

value - the value to set.

DeviceSetting

public DeviceSetting(DeviceSetting deviceSetting)

Clone constructor.

Parameters:

deviceSetting - The device setting to clone.

Method Detail

clone

public DeviceSetting clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

setDeviceProperty

public void setDeviceProperty(java.lang.String device,
                              java.lang.String property)

Sets the device property which this setting represents.

Parameters:

device - the device to set.

property - the property to set.

getDevice

public java.lang.String getDevice()

Returns the device of which a property should be changed.

Returns:

the device.

getProperty

public java.lang.String getProperty()

Returns the property of the device which should be changed.

Returns:

the property.

setValue

public void setValue(java.lang.String value)

Sets the current value of the setting.

Parameters:

value - the value to set.

setValue

public void setValue(int value)

Sets the current value of the setting.

Parameters:

value - the value to set.

setValue

public void setValue(float value)

Sets the current value of the setting.

Parameters:

value - the value to set.

setRelativeValue

public void setRelativeValue(float offset)
                      throws java.lang.NumberFormatException

Sets the current value of the setting relative to its previous value. Same as setValue(getFloatValue() + offset)

Parameters:

offset - the offset to set.

Throws:

java.lang.NumberFormatException

setRelativeValue

public void setRelativeValue(int offset)
                      throws java.lang.NumberFormatException

Sets the current value of the setting relative to its previous value. Same as setValue(getIntegerValue() + offset)

Parameters:

offset - the offset to set.

Throws:

java.lang.NumberFormatException

getStringValue

public java.lang.String getStringValue()

Returns the value of the setting as a string.

Returns:

The current value as a string.

getIntegerValue

public int getIntegerValue()
                    throws java.lang.NumberFormatException

Returns the value of the setting as an integer.

Returns:

The current value as an integer.

Throws:

java.lang.NumberFormatException

getFloatValue

public float getFloatValue()
                    throws java.lang.NumberFormatException

Returns the value of the setting as a float.

Returns:

The current value as a float.

Throws:

java.lang.NumberFormatException

setAbsoluteValue

public void setAbsoluteValue(boolean absoluteValue)

Set to true if the property should be set to the given value, and to false if it should be changed for an offset relative to the current value.

Parameters:

absoluteValue - true if the property should be changed absolutely.

isAbsoluteValue

public boolean isAbsoluteValue()

Returns true if the property should be set to the given value, and false if it should be changed for an offset relative to the current value.

Returns:

true if the property should be changed absolutely.