desmoj.core.report.html5chart

Interface AbstractChartData<N extends java.lang.Number>

All Known Implementing Classes:

AbstractChartDataTable, ChartDataHistogramDouble, ChartDataHistogramLong, ChartDataTimeSeries

public interface AbstractChartData<N extends java.lang.Number>

An interface for chart data with a numerical data type.

Version:

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

Author:

Johanna Djimandjaja 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.

Method Summary

Modifier and Type	Method and Description
N	getDataValue(int index) Should return the data value at a given index.
N	getHighestDataValue() Should return the highest data value.
int	getNumOfData() Should return the number of data for this chart.
Model	getOwnerModel() Should return the owner Model this chart data is associated to.
boolean	isEmpty() Should return whether this chart data is empty or not.

Method Detail

getHighestDataValue

N getHighestDataValue()

Should return the highest data value. If there is no entry or the highest data value is a negative number, 0 should be returned.

Returns:

N: the highest data value for this chart

getNumOfData

int getNumOfData()

Should return the number of data for this chart.

Returns:

int: the number of data for this chart

getDataValue

N getDataValue(int index)

Should return the data value at a given index. If the data doesn't exist, 0 should be returned.

Parameters:

index -

Returns:

N: the data value at a given index

getOwnerModel

Model getOwnerModel()

Should return the owner Model this chart data is associated to.

Returns:

desmoj.core.simulator.Model : The model this chart data is associated to.

isEmpty

boolean isEmpty()

Should return whether this chart data is empty or not.
Should return true if this.getNumOfData()==0, else should return false.

Returns:

boolean: whether this chart data is empty or not