desmoj.core.simulator

Interface TimeFormatter

All Known Implementing Classes:

MultiUnitTimeFormatter, PatternBasedTimeFormatter, SingleUnitTimeFormatter

public interface TimeFormatter

An object that formats TimeInstant and TimeString objects.

Version:

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

Author:

Felix Klueckmann 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
java.lang.String	buildTimeString(TimeInstant instant) Returns the String representation of the given instant of time.
java.lang.String	buildTimeString(TimeSpan span) Returns the String representation of the given span of time.
java.lang.String	getUnit() The units used to format time span and time instants.

Method Detail

buildTimeString

java.lang.String buildTimeString(TimeInstant instant)

Returns the String representation of the given instant of time.

Parameters:

instant - TimeInstant: the instant of time to be formatted

Returns:

String: the String representation of the given timeInstant

buildTimeString

java.lang.String buildTimeString(TimeSpan span)

Returns the String representation of the given span of time.

Parameters:

span - TimeSpan: the instant of time to be formatted

Returns:

String: the String representation of the given timeSpan.

getUnit

java.lang.String getUnit()

The units used to format time span and time instants.

Returns:

String: The description of the smallest time unit or all time units.