ch.agent.t2.time

Class Cycle

java.lang.Object

ch.agent.t2.time.Cycle

All Implemented Interfaces:

BasePeriodPattern

public class Cycle
extends Object
implements BasePeriodPattern

A Cycle is a BasePeriodPattern with a repeating sequence of ON and OFF time points. A cycle is defined using a boolean array.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
Cycle(boolean... pattern) Construct a cycle using the given pattern.

Method Summary

Modifier and Type	Method and Description
boolean	effective() Return true it the primary pattern has any effect.
boolean	equals(Object obj)
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.
int	hashCode()
long	makeIndex(long time) Compress an unrestricted numerical time index by removing all OFF time points.
boolean	matches(boolean[] pattern) Return true if the given pattern equals this pattern.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Cycle

public Cycle(boolean... pattern)

Construct a cycle using the given pattern.

Parameters:

pattern - a sequence of true and false values

Method Detail

getSize

public int getSize()

Description copied from interface: BasePeriodPattern

Return the number of time points in the pattern.

Specified by:

getSize in interface BasePeriodPattern

Returns:

a positive number

makeIndex

public long makeIndex(long time)
               throws T2Exception

Description copied from interface: BasePeriodPattern

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

Specified by:

makeIndex in interface BasePeriodPattern

Parameters:

time - an unrestricted numerical time index

Returns:

the numerical time index compressed

Throws:

T2Exception

expandIndex

public long expandIndex(long time)

Description copied from interface: BasePeriodPattern

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

Specified by:

expandIndex in interface BasePeriodPattern

Parameters:

time - a compressed numerical time index

Returns:

the numerical time index decompressed

effective

public boolean effective()

Description copied from interface: BasePeriodPattern

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

Specified by:

effective in interface BasePeriodPattern

Returns:

true if the pattern has any effect

matches

public boolean matches(boolean[] pattern)

Return true if the given pattern equals this pattern.

Parameters:

pattern - another sequence of true and false values

Returns:

true if both sequences are equal

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object