org.flexiblepower.ral.values

Class Profile<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Profile.Element<T>>

org.flexiblepower.ral.values.Profile<T>

Type Parameters:

T - The type of the values stored in the elements

All Implemented Interfaces:

java.lang.Iterable<Profile.Element<T>>, java.util.Collection<Profile.Element<T>>, java.util.List<Profile.Element<T>>

Direct Known Subclasses:

CommodityForecast, CommodityProfile, ConstraintProfile, UncertainMeasurableProfile

public abstract class Profile<T>
extends java.util.AbstractList<Profile.Element<T>>

Throughout this specification different profile types are being used. These profiles are all derived from this generic Profile class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Profile.Element<T> Represents each element in the profile.

Field Summary

Fields

Modifier and Type	Field and Description
protected Profile.Element<T>[]	elements The array that contains all the elements.
static javax.measure.unit.Unit<javax.measure.quantity.Duration>	MS The unit for milliseconds.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Profile(Profile.Element<T>... elements) Creates a new instance of the profile by using the given elements.

Method Summary

Methods

Modifier and Type	Method and Description
Profile.Element<T>	get(int index)
Profile.Element<T>	getElementAtOffset(javax.measure.Measurable<javax.measure.quantity.Duration> offset) Find the element in the Profile at a specific offset.
javax.measure.Measurable<javax.measure.quantity.Duration>	getTotalDuration()
int	size()
abstract Profile<T>	subProfile(javax.measure.Measurable<javax.measure.quantity.Duration> offset, javax.measure.Measurable<javax.measure.quantity.Duration> duration) An extension of the profile should implement this method to be able to split the profile up into parts.

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Field Detail

MS

public static final javax.measure.unit.Unit<javax.measure.quantity.Duration> MS

The unit for milliseconds.

elements

protected final Profile.Element<T>[] elements

The array that contains all the elements.

Constructor Detail

Profile

protected Profile(Profile.Element<T>... elements)

Creates a new instance of the profile by using the given elements.

Parameters:

elements - The array of elements (in order!) that make up this profile.

Method Detail

get

public Profile.Element<T> get(int index)

Specified by:

get in interface java.util.List<Profile.Element<T>>

Specified by:

get in class java.util.AbstractList<Profile.Element<T>>

size

public int size()

Specified by:

size in interface java.util.Collection<Profile.Element<T>>

Specified by:

size in interface java.util.List<Profile.Element<T>>

Specified by:

size in class java.util.AbstractCollection<Profile.Element<T>>

getTotalDuration

public javax.measure.Measurable<javax.measure.quantity.Duration> getTotalDuration()

Returns:

The total duration of the whole profile. This sums all the durations of the elements.

getElementAtOffset

public Profile.Element<T> getElementAtOffset(javax.measure.Measurable<javax.measure.quantity.Duration> offset)

Find the element in the Profile at a specific offset.

Parameters:

offset - Measurable<Duration> of the offset to search for an element

Returns:

The element of the profile at offset or null if the offset is bigger than the profile

subProfile

public abstract Profile<T> subProfile(javax.measure.Measurable<javax.measure.quantity.Duration> offset,
                    javax.measure.Measurable<javax.measure.quantity.Duration> duration)

An extension of the profile should implement this method to be able to split the profile up into parts. This method should select a single part of the whole profile.

Parameters:

offset - The offset of where the subsection of the profile should start. This should always be >= 0.

duration - The total duration of the new profile. The offset + duration should never be more than the total duration of this profile.

Returns:

A new Profile implementation that represents the selected subprofile.