desmoj.core.statistic

Class BoolStatistic

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.statistic.BoolStatistic

public class BoolStatistic
extends Reportable

The BoolStatistic class is providing a statistic analysis about a boolean value. Statistics include true-ratio and total number of observations.

Version:

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

Author:

Soenke Claassen, based on DESMO-C from Thomas Schniewind, 1998, modified by Ruth Meyer, Johannes Göbel 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
BoolStatistic(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a BoolStatistic object.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this BoolStatistic.
long	getTrueObs() Returns the number of trues observed so far.
double	getTrueRatio() Returns the ratio of trues per total observations so far.
void	reset() Resets this BoolStatistic object by deleting a observations this far.
void	update(boolean val) Updates this BoolStatistic object with a boolean double value given as parameter.

Methods inherited from class desmoj.core.simulator.Reportable

getCorrespondingSchedulable, getDescription, getObservations, getReporter, incrementObservations, incrementObservations, reportIsOn, reportOff, reportOn, resetAt, setCorrespondingSchedulable, setDescription, setReporter

Methods inherited from class desmoj.core.simulator.ModelComponent

current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, debugIsOn, debugOff, debugOn, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn

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

BoolStatistic

public BoolStatistic(Model ownerModel,
                     java.lang.String name,
                     boolean showInReport,
                     boolean showInTrace)

Constructor for a BoolStatistic object. No connection to a ValueSupplier.

Parameters:

ownerModel - Model : The model this BoolStatistic is associated to

name - java.lang.String : The name of this BoolStatistic object

showInReport - boolean : Flag for showing the report about BoolStatistic Tally.

showInTrace - boolean : Flag for showing the trace output of BoolStatistic Tally.

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this BoolStatistic.

Returns:

desmoj.report.Reporter : The Reporter for this BoolStatistic.

getTrueObs

public long getTrueObs()

Returns the number of trues observed so far.

Returns:

long : The number of trues observed so far.

getTrueRatio

public double getTrueRatio()

Returns the ratio of trues per total observations so far.

Returns:

double : The ratio of trues per total observations so far.

reset

public void reset()

Resets this BoolStatistic object by deleting a observations this far.

Overrides:

reset in class Reportable

update

public void update(boolean val)

Updates this BoolStatistic object with a boolean double value given as parameter.

Parameters:

val - boolean : The value with which this BoolStatistic will be updated.