ch.agent.t2.time

Interface BasePeriodPattern

All Known Implementing Classes:

Cycle

public interface BasePeriodPattern

A BasePeriodPattern defines a repeating pattern of time points. The pattern defines which time points are ON and which are OFF in a sequence of points of a well defined size.

Author:

Jean-Paul Vetterli

See Also:

TimePacker

Method Summary

Modifier and Type	Method and Description
boolean	effective() Return true it the primary pattern has any effect.
long	expandIndex(long time) Put back all removed OFF time points in a compressed numerical time index.
int	getSize() Return the number of time points in the pattern.
long	makeIndex(long time) Compress an unrestricted numerical time index by removing all OFF time points.

Method Detail

getSize

int getSize()

Return the number of time points in the pattern.

Returns:

a positive number

makeIndex

long makeIndex(long time)
        throws T2Exception

Compress an unrestricted numerical time index by removing all OFF time points. Return the compressed index.

Parameters:

time - an unrestricted numerical time index

Returns:

the numerical time index compressed

Throws:

T2Exception

expandIndex

long expandIndex(long time)

Put back all removed OFF time points in a compressed numerical time index. Return the uncompresse numerical time index.

Parameters:

time - a compressed numerical time index

Returns:

the numerical time index decompressed

effective

boolean effective()

Return true it the primary pattern has any effect. If if has no effect compression and decompression will leave inputs unchanged.

Returns:

true if the pattern has any effect