energy

Class FixedVariableHelper

java.lang.Object

energy.FixedVariableHelper

public class FixedVariableHelper
extends java.lang.Object

The Class FixedVariableHelper provides static help methods for FixedVariables that are are either FixedBoolean, FixedInteger or FixedDouble.

Constructor Summary

Constructors

Constructor and Description
FixedVariableHelper()

Method Summary

Modifier and Type	Method and Description
static FixedVariable	add(FixedVariable fv1, FixedVariable fv2) Adds the values of the specified two FixedVariables according to the value of the first parameter.
static FixedVariable	copyFixedVariable(FixedVariable fv) Copies the specified FixedVariable.
static FixedBoolean	createFixedBoolean(java.lang.String variableID, boolean value) Creates a new FixedBoolean.
static FixedDouble	createFixedDouble(java.lang.String variableID, java.lang.Double value) Creates a new FixedDouble.
static FixedInteger	createFixedInteger(java.lang.String variableID, java.lang.Integer value) Creates a new FixedInteger.
static java.lang.Number	getNumericValue(FixedVariable fv) Gets the numeric value of the specified FixedVariable.
static boolean	isEqualFixedVariableValue(FixedVariable fv1, FixedVariable fv2) Checks if is equal fixed variable value.

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedVariableHelper

public FixedVariableHelper()

Method Detail

add

public static FixedVariable add(FixedVariable fv1,
                                FixedVariable fv2)

Adds the values of the specified two FixedVariables according to the value of the first parameter.

Parameters:

fv1 - the first fixed variable ('variableID' will be taken from here)

fv2 - the second fixed variable

Returns:

the result fixed variable

getNumericValue

public static java.lang.Number getNumericValue(FixedVariable fv)

Gets the numeric value of the specified FixedVariable.
In case that the parameter is of type FixedBoolean, true will represented by -1 and false by 0;

Parameters:

fv - the FixedVariable

Returns:

the numeric value

copyFixedVariable

public static FixedVariable copyFixedVariable(FixedVariable fv)

Copies the specified FixedVariable.

Parameters:

fv - the FixedVariable

Returns:

the copied fixed variable

See Also:

FixedBoolean, FixedInteger, FixedDouble

isEqualFixedVariableValue

public static boolean isEqualFixedVariableValue(FixedVariable fv1,
                                                FixedVariable fv2)

Checks if is equal fixed variable value.

Parameters:

fv1 - the FixedVariable no. 1

fv2 - the FixedVariable no. 2

Returns:

true, if is equal fixed variable value

createFixedBoolean

public static FixedBoolean createFixedBoolean(java.lang.String variableID,
                                              boolean value)

Creates a new FixedBoolean.

Parameters:

variableID - the variable id

value - the value

Returns:

the fixed boolean

createFixedInteger

public static FixedInteger createFixedInteger(java.lang.String variableID,
                                              java.lang.Integer value)

Creates a new FixedInteger.

Parameters:

variableID - the variable id

value - the value

Returns:

the fixed integer

createFixedDouble

public static FixedDouble createFixedDouble(java.lang.String variableID,
                                            java.lang.Double value)

Creates a new FixedDouble.

Parameters:

variableID - the variable id

value - the value

Returns:

the fixed double