Class CrossSection

java.lang.Object

microsim.statistics.CrossSection

All Implemented Interfaces:

EventListener, ISourceObjectArray, IUpdatableSource

Direct Known Subclasses:

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

@Deprecated(forRemoval=true)
public abstract class CrossSection
extends Object
implements EventListener, IUpdatableSource, ISourceObjectArray

Deprecated, for removal: This API element is subject to removal in a future version.

use CrossSection instead

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

Nested Classes

Modifier and Type	Class	Description
static class	CrossSection.Double	Deprecated, for removal: This API element is subject to removal in a future version.
static class	CrossSection.Float	Deprecated, for removal: This API element is subject to removal in a future version.
static class	CrossSection.Integer	Deprecated, for removal: This API element is subject to removal in a future version.
static class	CrossSection.Long	Deprecated, for removal: This API element is subject to removal in a future version.

Field Summary

Fields

Modifier and Type	Field	Description
protected ICollectionFilter	filter	Deprecated, for removal: This API element is subject to removal in a future version.
protected Object[]	sourceList	Deprecated, for removal: This API element is subject to removal in a future version.
protected TimeChecker	timeChecker	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
CrossSection()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
ICollectionFilter	getFilter()	Deprecated, for removal: This API element is subject to removal in a future version.
Object[]	getSourceArray()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isCheckingTime()	Deprecated, for removal: This API element is subject to removal in a future version. Return the current status of the time checker.
void	onEvent(Enum<?> type)	Deprecated, for removal: This API element is subject to removal in a future version. ISimEventListener callback function.
void	setCheckingTime(boolean b)	Deprecated, for removal: This API element is subject to removal in a future version. Set the current status of the time checker.
void	setFilter(ICollectionFilter filter)	Deprecated, for removal: This API element is subject to removal in a future version.
abstract void	updateSource()	Deprecated, for removal: This API element is subject to removal in a future version. Force the source to update its currently cached data.

Methods inherited from class Object

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

Field Details

sourceList

protected Object[] sourceList

Deprecated, for removal: This API element is subject to removal in a future version.

timeChecker

protected TimeChecker timeChecker

Deprecated, for removal: This API element is subject to removal in a future version.

filter

protected ICollectionFilter filter

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Details

CrossSection

public CrossSection()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

updateSource

public abstract void updateSource()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: IUpdatableSource

Force the source to update its currently cached data.

Specified by:

updateSource in interface IUpdatableSource

onEvent

public void onEvent(Enum<?> type)

Deprecated, for removal: This API element is subject to removal in a future version.

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

Specified by:

onEvent in interface EventListener

Throws:

UnsupportedOperationException - If actionType is not supported.

getSourceArray

public Object[] getSourceArray()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getSourceArray in interface ISourceObjectArray

getFilter

public ICollectionFilter getFilter()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns:

setFilter

public void setFilter(ICollectionFilter filter)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

filter -

isCheckingTime

public boolean isCheckingTime()

Deprecated, for removal: This API element is subject to removal in a future version.

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.

setCheckingTime

public void setCheckingTime(boolean b)

Deprecated, for removal: This API element is subject to removal in a future version.

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.