desmoj.extensions.applicationDomains.harbour.report

Class TSReporter

java.lang.Object

desmoj.core.report.Reporter

desmoj.core.advancedModellingFeatures.report.StockReporter

desmoj.extensions.applicationDomains.harbour.report.TSReporter

public class TSReporter
extends StockReporter

Captures all relevant information about the TransporterSystem. That means from the transporter and the jobs queue.

Version:

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

Author:

Eugenia Neufeld 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
TSReporter(Reportable informationSource) Constructor for a new TSReporter.

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 TSReporter 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 TSReporter.

Methods inherited from class desmoj.core.advancedModellingFeatures.report.StockReporter

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

TSReporter

public TSReporter(Reportable informationSource)

Constructor for a new TSReporter. Note that although any Reportable is accepted you should make sure that only subtypes of TransporterSystem 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.Reportable : The TransporterSystem 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 this TransporterSystem. 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.

Overrides:

getEntries in class StockReporter

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 TSReporter as an array of Strings.

Overrides:

getStockColumnTitles in class StockReporter

Returns:

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

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 transporter and jobs queue of this TransporterSystem. Implement this method in a way, that an array of the same length as the tsColumns titles is produced containing the data at the point of time this method is called by someone else to produce up-to-date information.

Overrides:

getStockEntries in class StockReporter

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 TSReporter.

Overrides:

getStockNumColumns in class StockReporter

Returns:

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