ch.agent.t2.time

Interface SubPeriodPattern

All Known Implementing Classes:

DayRankingSubPeriodPattern, SimpleSubPeriodPattern

public interface SubPeriodPattern

A SubperiodPattern defines a set of higher resolution time points within a base unit. It is applied after the base period pattern, if any. This makes it possible to define a time domain like "at 10:00, 12:30, and 16:45 on every working day" for example, where the base pattern is used to model working days and the sub period pattern is used to define the within day times.

Author:

Jean-Paul Vetterli

See Also:

TimePacker

Method Summary

Modifier and Type	Method and Description
long	adjustForSubPeriod(long time, Adjustment adjust, TimeParts timeParts) Modify and return the numeric time index corresponding to the state of the time parts argument.
TimeParts	fillInSubPeriod(int subPeriod, TimeParts timeParts) Update the relevant field of the time parts argument for the given sub period and return a modified copy.
Resolution	getBasePeriod() Return the base period resolution.
int	getSize() Return the number of sub periods.
Resolution	getSubPeriod() Return the sub period resolution.

Method Detail

getSize

int getSize()

Return the number of sub periods.

Returns:

a positive number

getSubPeriod

Resolution getSubPeriod()

Return the sub period resolution.

Returns:

a resolution

getBasePeriod

Resolution getBasePeriod()

Return the base period resolution.

Returns:

a resolution

adjustForSubPeriod

long adjustForSubPeriod(long time,
                        Adjustment adjust,
                        TimeParts timeParts)
                 throws T2Exception

Modify and return the numeric time index corresponding to the state of the time parts argument. The numeric time index passed as an argument reflects those fields of the time parts argument relevant to the base unit and incorporates the effect from the base period pattern. Remaining fields of the time parts argument are either used to determined the sub period or are ignored. This method is intended for used by TimePacker.pack(TimeParts, Adjustment).

Parameters:

time - a numeric time index

adjust - an allowed adjustment mode

timeParts - a time parts object with the complete time specification

Returns:

the numeric time index adjusted for the sub period

Throws:

T2Exception

fillInSubPeriod

TimeParts fillInSubPeriod(int subPeriod,
                          TimeParts timeParts)

Update the relevant field of the time parts argument for the given sub period and return a modified copy. This method is intended for used by TimePacker.unpack(long).

Parameters:

subPeriod - a positive number

timeParts - a time parts object to be modified

Returns:

a new time parts object