energy

Class InputMeasurementHelper

java.lang.Object

energy.InputMeasurementHelper

public class InputMeasurementHelper
extends java.lang.Object

The Class InputMeasurementHelper provides static help methods for InputMeasurements.

Constructor Summary

Constructors

Constructor and Description
InputMeasurementHelper()

Method Summary

Modifier and Type	Method and Description
static InputMeasurement	add(InputMeasurement im1, InputMeasurement im2) Adds the values of the specified two InputMeasurements according to the time ranges of both series and the settings of the first input measurement.
static void	addAllMeasurements(InputMeasurement imResult, InputMeasurement imToAdd) Adds all measurements .
static InputMeasurement	applyDataRepetitionToInputMeasurement(InputMeasurement im, DataRepetition dataRepetition, long timeOfEvaluationStart, long timeOfEvaluationEnd) Applies the DataRepetition to the specified InputMeasurement.
static InputMeasurement	copyInputMeasurement(InputMeasurement im, long offset) Copies the specified InputMeasurement and applies an offset to the time values.
static InputMeasurementByTime	copyInputMeasurementByTime(InputMeasurementByTime imbt) Copies the specified InputMeasurementByTime.
static InputMeasurementByTime	createInputMeasurementByTime(long newTime, FixedVariable valueToAdd) Creates the input measurement by time.
static FixedVariable	getInputMeasurement4PointInTime(long pointInTime, InputMeasurement im, DataRepetition dataRepetition) Gets the actual input measurement as FixedVariable for the specified point in time.
static java.util.TreeSet<java.lang.Long>	getSortedAndUniqueTimeEvents(InputMeasurement im) Gets the sorted time events of the specified InputMeasurement.
static java.util.TreeSet<java.lang.Long>	getSortedAndUniqueTimeEvents(InputMeasurement im, java.util.TreeSet<java.lang.Long> timeEvents) Gets the sorted time events of the specified InputMeasurement and the already know events from the second parameter.
static java.lang.String	toString(InputMeasurement im) Return the specified InputMeasurement as string.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputMeasurementHelper

public InputMeasurementHelper()

Method Detail

addAllMeasurements

public static void addAllMeasurements(InputMeasurement imResult,
                                      InputMeasurement imToAdd)

Adds all measurements .

add

public static InputMeasurement add(InputMeasurement im1,
                                   InputMeasurement im2)

Adds the values of the specified two InputMeasurements according to the time ranges of both series and the settings of the first input measurement.

Parameters:

im1 - the first input measurement ('variableID' and 'step series' will be taken from here)

im2 - the second input measurement

Returns:

the result input measurement

getSortedAndUniqueTimeEvents

public static java.util.TreeSet<java.lang.Long> getSortedAndUniqueTimeEvents(InputMeasurement im)

Gets the sorted time events of the specified InputMeasurement.

Parameters:

im - the InputMeasurement

Returns:

the sorted time events

getSortedAndUniqueTimeEvents

public static java.util.TreeSet<java.lang.Long> getSortedAndUniqueTimeEvents(InputMeasurement im,
                                                                             java.util.TreeSet<java.lang.Long> timeEvents)

Gets the sorted time events of the specified InputMeasurement and the already know events from the second parameter.

Parameters:

im - the InputMeasurement

timeEvents - the time events

Returns:

the sorted time events

getInputMeasurement4PointInTime

public static FixedVariable getInputMeasurement4PointInTime(long pointInTime,
                                                            InputMeasurement im,
                                                            DataRepetition dataRepetition)

Gets the actual input measurement as FixedVariable for the specified point in time.

Parameters:

pointInTime - the point in time

im - the InputMeasurement

dataRepetition - the data repetition

Returns:

the input measurement for the point in time

applyDataRepetitionToInputMeasurement

public static InputMeasurement applyDataRepetitionToInputMeasurement(InputMeasurement im,
                                                                     DataRepetition dataRepetition,
                                                                     long timeOfEvaluationStart,
                                                                     long timeOfEvaluationEnd)

Applies the DataRepetition to the specified InputMeasurement.

Parameters:

im - the InputMeasurement

dataRepetition - the DataRepetition

timeOfEvaluationStart - the time of the evaluation

timeOfEvaluationEnd - the end time of evaluation

Returns:

the time shifted InputMeasurement

copyInputMeasurement

public static InputMeasurement copyInputMeasurement(InputMeasurement im,
                                                    long offset)

Copies the specified InputMeasurement and applies an offset to the time values.

Parameters:

im - the InputMeasurement to copy

offset - the offset for the time values

Returns:

the copied InputMeasurement

copyInputMeasurementByTime

public static InputMeasurementByTime copyInputMeasurementByTime(InputMeasurementByTime imbt)

Copies the specified InputMeasurementByTime.

Parameters:

imbt - the InputMeasurementByTime instance to copy

Returns:

the copy of the InputMeasurementByTime

toString

public static java.lang.String toString(InputMeasurement im)

Return the specified InputMeasurement as string.

Parameters:

im - the InputMeasurement

Returns:

the string

createInputMeasurementByTime

public static InputMeasurementByTime createInputMeasurementByTime(long newTime,
                                                                  FixedVariable valueToAdd)

Creates the input measurement by time.

Parameters:

newTime - the new time

valueToAdd - the value to add

Returns:

the input measurement by time