org.flexiblepower.ral.values

Class ConstraintProfile<Q extends javax.measure.quantity.Quantity>

java.lang.Object

java.util.AbstractCollection<E>

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

org.flexiblepower.ral.values.Profile<Constraint<Q>>

org.flexiblepower.ral.values.ConstraintProfile<Q>

All Implemented Interfaces:

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

public final class ConstraintProfile<Q extends javax.measure.quantity.Quantity>
extends Profile<Constraint<Q>>

This class is derived from Profile and is parameterized with a Constraint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConstraintProfile.Builder<Q extends javax.measure.quantity.Quantity> The Builder object that will be used to easily create ConstraintProfiles.

Nested classes/interfaces inherited from class org.flexiblepower.ral.values.Profile

Profile.Element<T>

Field Summary

Fields inherited from class org.flexiblepower.ral.values.Profile

elements, MS

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ConstraintProfile(Profile.Element<Constraint<Q>>... elements) Constructor of the ConstraintProfile, using the elements given.

Method Summary

Methods

Modifier and Type	Method and Description
static <Q extends javax.measure.quantity.Quantity> ConstraintProfile.Builder<Q>	create()
ConstraintProfile<Q>	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 org.flexiblepower.ral.values.Profile

get, getElementAtOffset, getTotalDuration, size

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

Constructor Detail

ConstraintProfile

public ConstraintProfile(Profile.Element<Constraint<Q>>... elements)

Constructor of the ConstraintProfile, using the elements given. The elements will be copied into a new array.

Parameters:

elements - The elements that are stored in this profile

Method Detail

create

public static <Q extends javax.measure.quantity.Quantity> ConstraintProfile.Builder<Q> create()

Returns:

A builder object to easily create new ConstraintProfiles.

subProfile

public ConstraintProfile<Q> subProfile(javax.measure.Measurable<javax.measure.quantity.Duration> offset,
                              javax.measure.Measurable<javax.measure.quantity.Duration> duration)

Description copied from class: Profile

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.

Specified by:

subProfile in class Profile<Constraint<Q extends javax.measure.quantity.Quantity>>

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.