Package etomica.modifier

Class ModifierGeneral

java.lang.Object

etomica.modifier.ModifierGeneral

All Implemented Interfaces:

Modifier, java.io.Serializable

Direct Known Subclasses:

ModifierFunctionWrapper

public class ModifierGeneral
extends java.lang.Object
implements Modifier, java.io.Serializable

Implements the Modifier functionality using introspection to obtain the accessor methods for a property. Capable of modifying the same property for several objects at once (e.g., temperature for two different integrator objects can be set simultaneously). In the case of multi-object modification, calls to readValue are taken from only the first object in the list, which assumes all would return the same value

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Object[]	object
protected java.lang.String	property
protected java.lang.reflect.Method[]	readMethod
protected java.lang.reflect.Method[]	writeMethod

Constructor Summary

Constructors

Constructor	Description
ModifierGeneral(java.lang.Object[] obj, java.lang.String prop)	Constructor connecting the modifier's getValue and setValue methods to the set/get accessor methods of the object being modifier.
ModifierGeneral(java.lang.Object obj, java.lang.String prop)	Modifier for property of a single object (most common use)

Method Summary

Modifier and Type	Method	Description
Dimension	getDimension()	Returns the dimension of the property being modified.
java.lang.String	getLabel()	Returns a descriptive label of the property being modified.
java.lang.Object[]	getObject()
java.lang.String	getProperty()
double	getValue()	Gets the current value of the property.
void	setLabel(java.lang.String label)
void	setValue(double d)	Sets the value of the property.

Methods inherited from class java.lang.Object

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

Field Detail

object

protected java.lang.Object[] object

property

protected java.lang.String property

readMethod

protected transient java.lang.reflect.Method[] readMethod

writeMethod

protected transient java.lang.reflect.Method[] writeMethod

Constructor Detail

ModifierGeneral

public ModifierGeneral(java.lang.Object[] obj,
                       java.lang.String prop)

Constructor connecting the modifier's getValue and setValue methods to the set/get accessor methods of the object being modifier. If the accessor methods of the object are, for example getTime and setTime, then the string "time" should be passed in the constructor. Note the adherance to the JavaBeans case conventions for property and accessor names.

Parameters:

obj - the object with the property to be modified

prop - the name of the property being modified

ModifierGeneral

public ModifierGeneral(java.lang.Object obj,
                       java.lang.String prop)

Modifier for property of a single object (most common use)

Method Detail

setValue

public void setValue(double d)

Description copied from interface: Modifier

Sets the value of the property.

Specified by:

setValue in interface Modifier

getValue

public double getValue()

Description copied from interface: Modifier

Gets the current value of the property.

Specified by:

getValue in interface Modifier

Returns:

getLabel

public java.lang.String getLabel()

Description copied from interface: Modifier

Returns a descriptive label of the property being modified.

Specified by:

getLabel in interface Modifier

Returns:

Returns the label.

setLabel

public void setLabel(java.lang.String label)

Parameters:

label - The label to set. Default is the property name.

getDimension

public Dimension getDimension()

Description copied from interface: Modifier

Returns the dimension of the property being modified.

Specified by:

getDimension in interface Modifier

getObject

public java.lang.Object[] getObject()

getProperty

public java.lang.String getProperty()