sidnet.core.interfaces
Class ColorProfile

java.lang.Object
  sidnet.core.interfaces.ColorProfile

All Implemented Interfaces:

ColorProfileInterface

Direct Known Subclasses:

ColorProfile802_15_4, ColorProfileElectrostatic, ColorProfileGeneric, ColorProfileGeneric, ColorProfileMac802_11_4, ColorProfileSweep, ColorProfileTriggers

public abstract class ColorProfile
extends java.lang.Object
implements ColorProfileInterface

Nested Class Summary

class

ColorProfile.ColorBundle

Field Summary

boolean	changed
static int	CLEAR Duration marker, clear the last set color
static java.lang.String	DEAD The tag for dead nodes
static java.lang.String	DEFAULT
static int	FOREVER Event marker, indicates an indefinite duration for which the last specified color will be applied
static java.lang.String	SELECTED The tag for selected nodes

Constructor Summary

ColorProfile()
Constructor function in which you must define the assignment of colors to the array

Method Summary

ColorProfile.ColorBundle	getColorBundle(java.lang.String tag)
ColorPair	getColorSet() Returns the ColorPair associated with a given instance of an implementation function
long	getTimeToColorChange() Get remaining (simulation) time before the last paint is cleared
void	mark(ColorProfile clientColorProfile, java.lang.String tag, long duration) Mark a given node
void	register(ColorProfile.ColorBundle colorBundle)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FOREVER

public static final int FOREVER

Event marker, indicates an indefinite duration for which the last specified color will be applied

See Also:

Constant Field Values

CLEAR

public static final int CLEAR

Duration marker, clear the last set color

See Also:

Constant Field Values

DEAD

public static final java.lang.String DEAD

The tag for dead nodes

See Also:

Constant Field Values

SELECTED

public static final java.lang.String SELECTED

The tag for selected nodes

See Also:

Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT

See Also:

Constant Field Values

changed

public boolean changed

Constructor Detail

ColorProfile

public ColorProfile()

Constructor function in which you must define the assignment of colors to the array

Method Detail

register

public void register(ColorProfile.ColorBundle colorBundle)

mark

public void mark(ColorProfile clientColorProfile,
                 java.lang.String tag,
                 long duration)

Mark a given node

Parameters:

event - event marker

duration - either a marker, or an integer value. The latter indicates the amount of time, in [ms]-simulation time, the mark will last

getColorSet

public ColorPair getColorSet()

Returns the ColorPair associated with a given instance of an implementation function

getTimeToColorChange

public long getTimeToColorChange()

Get remaining (simulation) time before the last paint is cleared

getColorBundle

public ColorProfile.ColorBundle getColorBundle(java.lang.String tag)

Specified by:

getColorBundle in interface ColorProfileInterface