Docs For Class Time

Class Time

Description

This represents a period of time.

My implementation uses one SmallIntegers: seconds - number of seconds since midnight.

To create new Time instances, use one of the static instance-creation methods, NOT 'new Time':

Time::fromString($aString)
Time::midnight()
Time::noon()
Time::withHourMinuteSecond($anIntHour, $anIntMinute, $anIntSecond)
Time::withSeconds($anIntSeconds)

link: http://harmoni.sourceforge.net/
author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: Time.class.php,v 1.7 2007/09/04 20:25:25 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 5/5/05

Located in /harmoni/core/Primitives/Chronology/Time.class.php (line 49)

SObject
   |
   --Magnitude
      |
      --Time

Variable Summary

integer $seconds

Method Summary

object Time addSeconds (integer $anInteger)

object Time addTime (object $timeAmount)

object Date asDate ()

object DateAndTime asDateAndTime ()

object Duration asDuration ()

object Month asMonth ()

integer asSeconds ()

object Time asTime ()

object TimeStamp asTimeStamp ()

object Year asWeek ()

object Year asYear ()

object Duration duration ()

object Time fromString (string $aString, [optional $class = 'Time'])

integer hour ()

integer hour12 ()

integer hour24 ()

boolean isEqualTo (object $comparand)

boolean isLessThan (object $comparand)

string meridianAbbreviation ()

object Time midnight ([optional $class = 'Time'])

integer minute ()

object Time noon ([optional $class = 'Time'])

string printableString ()

integer second ()

void setSeconds (ingteger $anIntSeconds)

string string12 ([optional $showSeconds = TRUE])

string string24 ([optional $showSeconds = TRUE])

object Time subtractTime (object $timeAmount)

array ticks ()

object Timespan to (object $anEnd)

object Time withHourMinuteSecond (integer $anIntHour, integer $anIntMinute, integer $anIntSecond, [optional $class = 'Time'])

object Time withSeconds (integer $anIntSeconds, [optional $class = 'Time'])

Variables

integer $seconds (line 58)

var: The seconds from midnight of this time
since: 5/11/05
access: private

Methods

addSeconds (line 420)

Answer a Time that is nSeconds after the receiver.

since: 5/25/05
access: public

object Time addSeconds (integer $anInteger)

integer $anInteger

addTime (line 434)

Answer a Time that is timeInterval after the receiver. timeInterval is an instance of Date or Time.

since: 5/25/05
access: public

object Time addTime (object $timeAmount)

object $timeAmount: An instance of Date or Time.

asDate (line 465)

Answer a Date that represents this object

since: 5/5/05
access: public

object Date asDate ()

asDateAndTime (line 477)

Answer a DateAndTime that represents this object

since: 5/4/05
access: public

object DateAndTime asDateAndTime ()

asDuration (line 491)

Answer a Duration that represents this object, the duration since midnight.

since: 5/4/05
access: public

object Duration asDuration ()

asMonth (line 503)

Answer the month that represents this date's month

since: 5/5/05
access: public

object Month asMonth ()

asSeconds (line 516)

Answer the number of seconds since midnight of the receiver.

since: 5/5/05
access: public

integer asSeconds ()

asTime (line 527)

Answer a Time that represents our time component

since: 5/5/05
access: public

object Time asTime ()

asTimeStamp (line 538)

Answer a Timestamp that represents this DateAndTime

since: 5/5/05
access: public

object TimeStamp asTimeStamp ()

asWeek (line 551)

Answer this time as a Week

since: 5/5/05
access: public

object Year asWeek ()

asYear (line 564)

Answer this time as a Year

since: 5/5/05
access: public

object Year asYear ()

duration (line 218)

Answer the duration of this object (always zero)

since: 5/5/05
access: public

object Duration duration ()

fromString (line 79)

Read a Time from the stream in the forms:

<hour24>:<minute>:<second>
<hour>:<minute>:<second> <am/pm>
<minute>, <second> or <am/pm> may be omitted. e.g. 1:59:30 pm; 8AM; 15:30

since: 5/24/05
access: public

object Time fromString (string $aString, [optional $class = 'Time'])

string $aString
optional $class: string $class DO NOT USE OUTSIDE OF PACKAGE. This parameter is used to get around the limitations of not being able to find the class of the object that recieved the initial method call.

hour (line 230)

Answer the hours (0-23)

since: 5/3/05
access: public

integer hour ()

hour12 (line 242)

Answer an <integer> between 1 and 12, inclusive, representing the hour of the day in the 12-hour clock of the local time of the receiver.

since: 5/4/05
access: public

integer hour12 ()

hour24 (line 256)

Answer the hours (0-23)

since: 5/3/05
access: public

integer hour24 ()

isEqualTo (line 376)

comparand conforms to protocol DateAndTime, or can be converted into something that conforms.

since: 5/3/05
access: public

boolean isEqualTo (object $comparand)

object $comparand

Redefinition of:

Magnitude::isEqualTo(): Test if this is equal to aMagnitude.

isLessThan (line 402)

comparand conforms to protocol DateAndTime, or can be converted into something that conforms.

since: 5/3/05
access: public

boolean isLessThan (object $comparand)

object $comparand

Redefinition of:

Magnitude::isLessThan(): Test if this is less than aMagnitude.

meridianAbbreviation (line 268)

Return the Meridian Abbreviation ('AM'/'PM')

since: 5/5/05
access: public

string meridianAbbreviation ()

midnight (line 103)

Answer the Time at midnight

since: 5/25/05
access: public

object Time midnight ([optional $class = 'Time'])

optional $class: string $class DO NOT USE OUTSIDE OF PACKAGE. This parameter is used to get around the limitations of not being able to find the class of the object that recieved the initial method call.

minute (line 282)

Answer the minute (0-59)

since: 5/3/05
access: public

integer minute ()

noon (line 119)

Answer the Time at noon

since: 5/25/05
access: public

object Time noon ([optional $class = 'Time'])

optional $class: string $class DO NOT USE OUTSIDE OF PACKAGE. This parameter is used to get around the limitations of not being able to find the class of the object that recieved the initial method call.

printableString (line 348)

Format is 'h:mm<:ss> am'

since: 5/20/05
access: public

string printableString ()

Redefinition of:

SObject::printableString(): Answer a String whose characters are a description of the receiver.

second (line 359)

Answer the second (0-59)

since: 5/3/05
access: public

integer second ()

setSeconds (line 192)

Set our seconds

since: 5/5/05
access: private

void setSeconds (ingteger $anIntSeconds)

ingteger $anIntSeconds

string12 (line 295)

Format is 'h:mm:ss am' or, if showSeconds is false, 'h:mm am'

since: 5/20/05
access: public

string string12 ([optional $showSeconds = TRUE])

optional $showSeconds: boolean $showSeconds

string24 (line 328)

Format is 'hh:mm:ss' or, if showSeconds is false, 'hh:mm'

since: 5/20/05
access: public

string string24 ([optional $showSeconds = TRUE])

optional $showSeconds: boolean $showSeconds

subtractTime (line 448)

Answer a Time that is timeInterval before the receiver. timeInterval is an instance of Date or Time.

since: 5/25/05
access: public

object Time subtractTime (object $timeAmount)

object $timeAmount: An instance of Date or Time.

ticks (line 203)

Private - answer an array with our instance variables. Assumed to be UTC

since: 5/4/05
access: private

array ticks ()

to (line 578)

Answer a Timespan. anEnd must respond to asDateAndTime()

since: 5/25/05
access: public

object Timespan to (object $anEnd)

object $anEnd: anEnd must understand asDateAndTime()

withHourMinuteSecond (line 139)

Answer a Time from midnight

since: 5/4/05
static:
access: public

object Time withHourMinuteSecond (integer $anIntHour, integer $anIntMinute, integer $anIntSecond, [optional $class = 'Time'])

integer $anIntHour
integer $anIntMinute
integer $anIntSecond
optional $class: string $class DO NOT USE OUTSIDE OF PACKAGE. This parameter is used to get around the limitations of not being able to find the class of the object that recieved the initial method call.

withSeconds (line 157)

Answer a Time from midnight

since: 5/5/05
access: public

object Time withSeconds (integer $anIntSeconds, [optional $class = 'Time'])

integer $anIntSeconds
optional $class: string $class DO NOT USE OUTSIDE OF PACKAGE. This parameter is used to get around the limitations of not being able to find the class of the object that recieved the initial method call.

Inherited Methods

Inherited From Magnitude

Magnitude::isBetween()
Magnitude::isEqualTo()
Magnitude::isGreaterThan()
Magnitude::isGreaterThanOrEqualTo()
Magnitude::isLessThan()
Magnitude::isLessThanOrEqualTo()
Magnitude::max()
Magnitude::min()

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()

Documentation generated on Wed, 19 Sep 2007 10:27:25 -0400 by phpDocumentor 1.3.0RC3