desmoj.extensions.scheduling

Class EntityScheduleEntry

java.lang.Object

desmoj.extensions.scheduling.EntityScheduleEntry

public class EntityScheduleEntry
extends java.lang.Object

EntityScheduleEntry is an entry of EntitySchedule. A EntityScheduleEntry is a time region (e.g. every workingday from 8:00 until 16:00) All EntityScheduleEntry of a EntitySchedule have the same timezone, set by EntitySchedule.

Version:

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

Author:

christian.mueller@th-wildau.de, christian.mueller@th-wildau.de 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
EntityScheduleEntry(Model model, TimeSpan fromBeginOfDay, TimeSpan untilBeginOfDay) Create an schedule entry with daily time border.
EntityScheduleEntry(Model model, TimeSpan fromBeginOfDay, TimeSpan untilBeginOfDay, double value)
EntityScheduleEntry(Model model, TimeSpan fromBeginOfDay, TimeSpan untilBeginOfDay, java.lang.Object value) Create an schedule entry with daily time border and an entry value.

Method Summary

Modifier and Type	Method and Description
TimeInstant	getEnd(TimeInstant time) Get end time of this Entry for given date.
java.lang.Object[]	getValues() Get values array of entry
void	setDayOfWeek(boolean[] dayOfWeek) active daysOfWeek in this schedule entry (SUN, MON, .., FRI, SAT)
void	setValidTimeRange(TimeInstant from, TimeInstant until) Global range of this schedule entry Default is null
void	setValues(java.lang.Object[] values) Each entry has a values array.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityScheduleEntry

public EntityScheduleEntry(Model model,
                           TimeSpan fromBeginOfDay,
                           TimeSpan untilBeginOfDay,
                           java.lang.Object value)

Create an schedule entry with daily time border and an entry value. Default values of this entry: validFrom and validUntil are not set (null) day of week (working days of this schedule) are MON..FRI values is {value} Defaults can be changed by approbate methods.

Parameters:

model -

fromBeginOfDay - TimeSpan from 0:00 until begin of entry. Must be smaller than 24h. Null is not allowed.

untilBeginOfDay - TimeSpan from 0:00 until end of entry. Null is not allowed.

value -

EntityScheduleEntry

public EntityScheduleEntry(Model model,
                           TimeSpan fromBeginOfDay,
                           TimeSpan untilBeginOfDay,
                           double value)

EntityScheduleEntry

public EntityScheduleEntry(Model model,
                           TimeSpan fromBeginOfDay,
                           TimeSpan untilBeginOfDay)

Create an schedule entry with daily time border. Default values of this entry: fromDate and untilDate are not set (null) day of week (working days of this schedule) are MON..FRI values is {1.0} Defaults can be changed by approbate methods. from/until Hour/Minutes are times of the same day

Parameters:

model -

fromHourOfDay -

fromMinute -

untilHourOfDay -

untilMinute -

Method Detail

setValidTimeRange

public void setValidTimeRange(TimeInstant from,
                              TimeInstant until)

Global range of this schedule entry Default is null

Parameters:

from -

until -

setDayOfWeek

public void setDayOfWeek(boolean[] dayOfWeek)

active daysOfWeek in this schedule entry (SUN, MON, .., FRI, SAT)

Parameters:

dayOfWeek -

setValues

public void setValues(java.lang.Object[] values)

Each entry has a values array. Default is {1.0}

Parameters:

capacity -

getValues

public java.lang.Object[] getValues()

Get values array of entry

Returns:

getEnd

public TimeInstant getEnd(TimeInstant time)

Get end time of this Entry for given date.

Parameters:

date -

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object