ikr.simlib.control.simulationcontrol

Class ControlCounter

java.lang.Object

ikr.simlib.control.simulationcontrol.SimNotifier

ikr.simlib.control.simulationcontrol.ControlCounter

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>, UnweightedSampleCollector<java.lang.Void>

public class ControlCounter
extends SimNotifier
implements UnweightedSampleCollector<java.lang.Void>

ControlCounter can be used to count any sort of event by calling the method Count(). Once a certain number of events has been reached, the simulation control is notified of the end of the current batch or the end of the transient phase. Using this object, a control of the simulation's batch duration based on the number of certain events can be achieved. Alternatively, the batch duration can be timer controlled using the class ControlTimer.

This class implements the UnweightedSampleCollector interface, so that it can be attached to a meter like a statistic would be attached. It then counts how often the update(Void) method is called. This class would typically be used together with a MessageCountMeter.

You can use asInstance() enforced by ReflectionConstructable to parse and create objects of type ControlCounter and ControlCountMeter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ControlCounter.State

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BATCH_CALLS
protected long	batchCount
protected long	count
protected int	currentBatch
protected long	limit
protected ControlCounter.State	state
static java.lang.String	TRANSIENT_CALLS
protected long	transientCount

Fields inherited from class ikr.simlib.control.simulationcontrol.SimNotifier

endOfBatchNotifier, endOfTransientPhaseNotifier

Fields inherited from interface ikr.simlib.parameters.reflection.ReflectionConstructable

CREATE_INSTANCE_METHOD_NAME

Constructor Summary

Constructors

Constructor and Description
ControlCounter(int transientCount, int batchCount)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	check()
void	count()
static ControlCounter	createInstance(SimNode ownNode, Parameters pars) as required by ReflectionConstructable
void	handleStartBatch(int batchNumber)
void	handleStartTransientPhase()
void	update(java.lang.Void value)

Methods inherited from class ikr.simlib.control.simulationcontrol.SimNotifier

deregisterSimNotifier, endOfBatch, endOfTransientPhase, handleStartSimulation, registerSimNotifier

Methods inherited from class java.lang.Object

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

Field Detail

TRANSIENT_CALLS

public static final java.lang.String TRANSIENT_CALLS

See Also:

Constant Field Values

BATCH_CALLS

public static final java.lang.String BATCH_CALLS

See Also:

Constant Field Values

state

protected ControlCounter.State state

currentBatch

protected int currentBatch

transientCount

protected long transientCount

batchCount

protected long batchCount

limit

protected long limit

count

protected long count

Constructor Detail

ControlCounter

public ControlCounter(int transientCount,
              int batchCount)

Method Detail

createInstance

public static ControlCounter createInstance(SimNode ownNode,
                            Parameters pars)

as required by ReflectionConstructable

check

protected void check()

count

public void count()

update

public void update(java.lang.Void value)

Specified by:

update in interface UnweightedSampleCollector<java.lang.Void>

handleStartBatch

public void handleStartBatch(int batchNumber)

Specified by:

handleStartBatch in class SimNotifier

handleStartTransientPhase

public void handleStartTransientPhase()

Specified by:

handleStartTransientPhase in class SimNotifier