jas.statistics
Class CrossSection

java.lang.Object
  jas.statistics.CrossSection

All Implemented Interfaces:

ISimEventListener, ISourceObjectArray, IUpdatableSource

Direct Known Subclasses:

CrossSection.Double, CrossSection.Float, CrossSection.Integer, CrossSection.Long

public abstract class CrossSection
extends java.lang.Object
implements ISimEventListener, IUpdatableSource, ISourceObjectArray

A cross section is a collection of values each of them representing the status of a given variable of an element of a collection of agents.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

Nested Class Summary

static class	CrossSection.Double
static class	CrossSection.Float
static class	CrossSection.Integer
static class	CrossSection.Long

Constructor Summary

CrossSection()

Method Summary

ICollectionFilter	getFilter()
java.lang.Object[]	getSourceArray()
boolean	isCheckingTime() Return the current status of the time checker.
void	performAction(int actionType) ISimEventListener callback function.
void	setCheckingTime(boolean b) Set the current status of the time checker.
void	setFilter(ICollectionFilter filter)
abstract void	updateSource() Force the source to update its currently cached data.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrossSection

public CrossSection()

Method Detail

getFilter

public ICollectionFilter getFilter()

Returns:

getSourceArray

public java.lang.Object[] getSourceArray()

Specified by:

getSourceArray in interface ISourceObjectArray

isCheckingTime

public boolean isCheckingTime()

Return the current status of the time checker. A time checker avoid the object to update more than one time per simulation step. The default value is enabled (true).

Returns:

True if the computer is currently checking time before update cached data, false if disabled.

performAction

public void performAction(int actionType)

ISimEventListener callback function. It supports only jas.engine.Sim.EVENT_UPDATE event.

Specified by:

performAction in interface ISimEventListener

Parameters:

actionType - The action id. Only jas.engine.Sim.EVENT_UPDATE is supported.

Throws:

java.lang.UnsupportedOperationException - If actionType is not supported.

setCheckingTime

public void setCheckingTime(boolean b)

Set the current status of the time checker. A time checker avoid the object to update more than one time per simulation step. The default value is enabled (true).

Parameters:

b - True if the computer is currently checking time before update cached data, false if disabled.

setFilter

public void setFilter(ICollectionFilter filter)

Parameters:

filter -

updateSource

public abstract void updateSource()

Description copied from interface: IUpdatableSource

Force the source to update its currently cached data.

Specified by:

updateSource in interface IUpdatableSource