energy.schedule

Class ScheduleTransformerKeyValueConfiguration

java.lang.Object

energy.schedule.ScheduleTransformerKeyValueConfiguration

All Implemented Interfaces:

java.io.Serializable

public class ScheduleTransformerKeyValueConfiguration
extends java.lang.Object
implements java.io.Serializable

The Class ScheduleTransformerKeyValueConfiguration configures the transformation of a regular Schedule to a key value structure.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduleTransformerKeyValueConfiguration.DeltaMechanism The possible DeltaMechanisms that create a value in a Schedule.

Constructor Summary

Constructors

Constructor and Description
ScheduleTransformerKeyValueConfiguration() Instantiates a new schedule transformer key value configuration (constructor for the serialisation).
ScheduleTransformerKeyValueConfiguration(java.lang.Float deltaPercentage, java.lang.Long timePeriodForLiveBit) Instantiates a new schedule transformer key value configuration for a percentage mechanism.
ScheduleTransformerKeyValueConfiguration(java.lang.Integer deltaAbsoluteInWatt, java.lang.Long timePeriodForLiveBit) Instantiates a new schedule transformer key value configuration for an absolute Watt value.

Method Summary

Modifier and Type	Method and Description
ScheduleTransformerKeyValueConfiguration	getCopy() Returns a copy of the current instance.
int	getDeltaAbsoluteWatt() Gets the delta absolute in Watt.
ScheduleTransformerKeyValueConfiguration.DeltaMechanism	getDeltaMechanism() Returns the current type of the delta mechanism.
float	getDeltaPercentage() Returns the delta in percent that is used in order to determine a new schedule value.
long	getTimePeriodForLiveBit() Returns the time period for the waiting period of live bits.
void	setDeltaAbsoluteWatt(int deltaAbsoluteWatt) Sets the delta absolute Watt.
void	setDeltaMechanism(ScheduleTransformerKeyValueConfiguration.DeltaMechanism deltaMechanism) Sets the type of the current delta mechanism.
void	setDeltaPercentage(float deltaPercentage) Sets the delta in percent that is used in order to determine a new schedule value.
void	setTimePeriodForLiveBit(long timePeriodForLiveBit) Sets the time period for the waiting period of live bits.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduleTransformerKeyValueConfiguration

public ScheduleTransformerKeyValueConfiguration()

Instantiates a new schedule transformer key value configuration (constructor for the serialisation).

ScheduleTransformerKeyValueConfiguration

public ScheduleTransformerKeyValueConfiguration(java.lang.Float deltaPercentage,
                                                java.lang.Long timePeriodForLiveBit)

Instantiates a new schedule transformer key value configuration for a percentage mechanism.

Parameters:

deltaPercentage - the delta percentage

timePeriodForLiveBit - the time period for live bit

See Also:

ScheduleTransformerKeyValueConfiguration.DeltaMechanism.Percentage

ScheduleTransformerKeyValueConfiguration

public ScheduleTransformerKeyValueConfiguration(java.lang.Integer deltaAbsoluteInWatt,
                                                java.lang.Long timePeriodForLiveBit)

Instantiates a new schedule transformer key value configuration for an absolute Watt value.

Parameters:

deltaAbsoluteInWatt - the delta absolute in watt

timePeriodForLiveBit - the time period for live bit

See Also:

ScheduleTransformerKeyValueConfiguration.DeltaMechanism.Absolute

Method Detail

setDeltaMechanism

public void setDeltaMechanism(ScheduleTransformerKeyValueConfiguration.DeltaMechanism deltaMechanism)

Sets the type of the current delta mechanism.

Parameters:

deltaMechanism - the new delta mechanism

getDeltaMechanism

public ScheduleTransformerKeyValueConfiguration.DeltaMechanism getDeltaMechanism()

Returns the current type of the delta mechanism.

Returns:

the delta mechanism

getDeltaAbsoluteWatt

public int getDeltaAbsoluteWatt()

Gets the delta absolute in Watt.

Returns:

the deltaAbsolutWatts

setDeltaAbsoluteWatt

public void setDeltaAbsoluteWatt(int deltaAbsoluteWatt)

Sets the delta absolute Watt.

Parameters:

deltaAbsoluteWatt - the deltaAbsolutWatts to set

getDeltaPercentage

public float getDeltaPercentage()

Returns the delta in percent that is used in order to determine a new schedule value.

Returns:

the deltaPercent

setDeltaPercentage

public void setDeltaPercentage(float deltaPercentage)

Sets the delta in percent that is used in order to determine a new schedule value.

Parameters:

deltaPercentage - the deltaPercent to set

setTimePeriodForLiveBit

public void setTimePeriodForLiveBit(long timePeriodForLiveBit)

Sets the time period for the waiting period of live bits.

Parameters:

timePeriodForLiveBit - the new time period for live bit

getTimePeriodForLiveBit

public long getTimePeriodForLiveBit()

Returns the time period for the waiting period of live bits.

Returns:

the time period for live bit

getCopy

public ScheduleTransformerKeyValueConfiguration getCopy()

Returns a copy of the current instance.

Returns:

the copy