desmoj.core.advancedModellingFeatures.report

Class StockReporter

java.lang.Object

desmoj.core.report.Reporter

desmoj.core.advancedModellingFeatures.report.StockReporter

Direct Known Subclasses:

CranesSystemReporter, TSReporter

public class StockReporter
extends Reporter

Captures all relevant information about the Stock. That means from the producer and the consumer queue.

Version:

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

Author:

Soenke Claassen 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
StockReporter(Reportable informationSource) Constructor for a new StockReporter.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getEntries() Returns an array of Strings each containing the data for the corresponding column in array columns[].
java.lang.String[]	getStockColumnTitles() Returns the titles of the wait queues part of this StockReporter as an array of Strings.
java.lang.String[]	getStockEntries() Returns an array of Strings each containing the data for the corresponding column in array stockColumns[].
int	getStockNumColumns() Returns the number of columns of the wait queues part of this StockReporter.
boolean	isContinuingReporter()

Methods inherited from class desmoj.core.report.Reporter

getColumnTitles, getDescription, getGroupID, getHeading, getModel, getNumOfSlaveQueues, getReportable, isEqual, isLarger, isOtherGroup, isSameGroup, isTwoRowReporter, makeAdditionalColorEntryIfHTMLColorChartIsGenerated, numColumns

Methods inherited from class java.lang.Object

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

Constructor Detail

StockReporter

public StockReporter(Reportable informationSource)

Constructor for a new StockReporter. Note that although any Reportable is accepted you should make sure that only subtypes of Stock are passed to this constructor. Otherwise the number of column titles and their individual headings will differ from the actual content collected by this reporter.

Parameters:

informationSource - desmoj.core.simulator.Reportable : The Stock to report about

Method Detail

getEntries

public java.lang.String[] getEntries()

Returns an array of Strings each containing the data for the corresponding column in array columns[]. This method is fetching the data from the master Stock. Implement this method in a way, that an array of the same length as the column titles is produced containing the data at the point of time this method is called by someone else to produce up-to-date information.

Specified by:

getEntries in class Reporter

Returns:

java.lang.String[] : Array containing the data for reporting.

getStockColumnTitles

public java.lang.String[] getStockColumnTitles()

Returns the titles of the wait queues part of this StockReporter as an array of Strings.

Returns:

java.lang.String[] : Array containing the titles of the wait queues part of this StockReporter.

getStockEntries

public java.lang.String[] getStockEntries()

Returns an array of Strings each containing the data for the corresponding column in array stockColumns[]. This method is fetching the data from the master Stock. Implement this method in a way, that an array of the same length as the stockColumns titles is produced containing the data at the point of time this method is called by someone else to produce up-to-date information.

Returns:

java.lang.String[] : Array containing the data for reporting.

getStockNumColumns

public int getStockNumColumns()

Returns the number of columns of the wait queues part of this StockReporter.

Returns:

int : The number of columns of the wait queues part of this StockReporter

isContinuingReporter

public boolean isContinuingReporter()

Overrides:

isContinuingReporter in class Reporter