desmoj.core.report

Class ReportManager

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.report.ReportManager

public class ReportManager
extends NamedObject

Controls all reports given by reportable model components used during an experiment.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Tim Lechler Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
ReportManager(java.lang.String name) Creates a new reportmanager with the given name.

Method Summary

Modifier and Type	Method and Description
void	addLast(Reporter r) Adds a report to the very end of the vector hanlded by this reportmanager.
void	deRegister(Reporter rep) De-registers the given reporter from the experiment's reportmanager.
java.util.List<Reporter>	elements() Returns a list view of all registered reporters in the appropriate order.
boolean	isEmpty() Returns a boolean value indicating whether this reportmanager contains reporters to be sent to the reportoutput or not.
void	register(Reporter rep) Registers the given reporter at the experiment's reportmanager.

Methods inherited from class desmoj.core.simulator.NamedObject

getName, getQuotedName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportManager

public ReportManager(java.lang.String name)

Creates a new reportmanager with the given name.

Parameters:

name - java.lang.String : the reportmanager's name

Method Detail

addLast

public void addLast(Reporter r)

Adds a report to the very end of the vector hanlded by this reportmanager. This is needed to place submodel reporters behind existing model reporters to prevent multiple models to be mixed.

Parameters:

r - desmoj.report.Reporter

deRegister

public void deRegister(Reporter rep)

De-registers the given reporter from the experiment's reportmanager. The reporter will be removed from the list of current available reporters and thus will not produce output whenever a report has to be produced. When de-registering, the order according to group-ID is preserved. If an invalid parameter is given (i.e. a null reference) this method simply returns

Parameters:

rep - desmoj.report.Reporter : The reporter to be de-registered

elements

public java.util.List<Reporter> elements()

Returns a list view of all registered reporters in the appropriate order.

Returns:

java.util.List : The list of reporters registered at the reportmanager

isEmpty

public boolean isEmpty()

Returns a boolean value indicating whether this reportmanager contains reporters to be sent to the reportoutput or not.

Returns:

boolean : Is true if the reportmanager conatains reporters, false otherwise

register

public void register(Reporter rep)

Registers the given reporter at the experiment's reportmanager. All reporters registered will be sent to the reportout whenever a report has to be produced. When registering, the order according to group-ID is preserved.

Parameters:

rep - desmoj.report.Reporter : The reporter to be registered