com.uc4.communication.requests

Class CalculateForecast

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.CalculateForecast

All Implemented Interfaces:

Iterable<ForecastItem>

public class CalculateForecast
extends XMLRequest
implements Iterable<ForecastItem>

Creates a new Forecast.

Constructor Summary

Constructors

Constructor and Description
CalculateForecast(int runID, UC4ObjectName forecastName) Creates a Forecast of a task.
CalculateForecast(UC4ObjectName object, UC4ObjectName forecastName, DateTime date, Time start) Calculates the Forecast of an object.

Method Summary

Modifier and Type	Method and Description
Iterator<ForecastItem>	iterator() Returns an iterator of the forecast list.
void	setPeriodicDayCount(int periodicDayCount) Sets the number of days for periodical tasks.
int	size()
void	useActualEntriesForGroups() If this method is called the actual entries are used in case of Groups.
void	useERTofGroups() If this method is called the ERT value is used in case of Groups.
void	useFixedValuesForGroups(int seconds) If this method is called the a fixed number of seconds is used in case of Groups.

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CalculateForecast

public CalculateForecast(int runID,
                         UC4ObjectName forecastName)

Creates a Forecast of a task.

Parameters:

runID - runID of the task

forecastName - Name of the forecast

CalculateForecast

public CalculateForecast(UC4ObjectName object,
                         UC4ObjectName forecastName,
                         DateTime date,
                         Time start)

Calculates the Forecast of an object.

Parameters:

object - Name of the UC4 object

forecastName - Name of the forecast

date - Logical date

start - Start time

Method Detail

useERTofGroups

public void useERTofGroups()

If this method is called the ERT value is used in case of Groups.

useActualEntriesForGroups

public void useActualEntriesForGroups()

If this method is called the actual entries are used in case of Groups.

useFixedValuesForGroups

public void useFixedValuesForGroups(int seconds)

If this method is called the a fixed number of seconds is used in case of Groups.

Parameters:

seconds - Seconds

setPeriodicDayCount

public void setPeriodicDayCount(int periodicDayCount)

Sets the number of days for periodical tasks.

Parameters:

periodicDayCount - Number of days

iterator

public Iterator<ForecastItem> iterator()

Returns an iterator of the forecast list. This list also contains the created forecast.

Specified by:

iterator in interface Iterable<ForecastItem>

Returns:

Iterator over ForecastItem

size

public int size()

Returns:

Number of rows returned