Docs For Class Magnitude

Description

Magnitude has methods for dealing with linearly ordered collections.

Subclasses represent dates, times, and numbers.

Example for interval-testing (answers a Boolean): $seven->between($five, $ten);

No instance-variables.

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

Located in /harmoni/core/Primitives/Magnitudes/Magnitude.class.php (line 38)

SObject
   |
   --Magnitude

Direct descendents

Class	Description
DateAndTime	I represent a point in UTC time as defined by ISO 8601. I have zero duration.
Duration	I represent a duration of time. I have been tested to support durations of up to 4 billion (4,000,000,000) years with second precision and up to 50 billion (50,000,000) years with hour precision. Durations beyond 50 billion years have not been tested.
Time	This represents a period of time.
Timespan	Timespan represents a duration starting at a specific DateAndTime.
Number	This is a partial port of the Squeak/Smalltalk Number class.

Method Summary

boolean isBetween (object Magnitude $min, object Magnitude $max)

boolean isEqualTo (object Magnitude $aMagnitude)

boolean isGreaterThan (object Magnitude $aMagnitude)

boolean isGreaterThanOrEqualTo (object Magnitude $aMagnitude)

boolean isLessThan (object Magnitude $aMagnitude)

boolean isLessThanOrEqualTo (object Magnitude $aMagnitude)

object Magnitude max (object Magnitude $aMagnitude)

object Magnitude min (object Magnitude $aMagnitude)

Methods

isBetween (line 114)

Answer whether the receiver is less than or equal to the argument, max, and greater than or equal to the argument, min.

since: 5/4/05
access: public

boolean isBetween (object Magnitude $min, object Magnitude $max)

object Magnitude $min
object Magnitude $max

isEqualTo (line 63)

Test if this is equal to aMagnitude.

since: 5/4/05
access: public

boolean isEqualTo (object Magnitude $aMagnitude)

object Magnitude $aMagnitude

Redefinition of:

SObject::isEqualTo(): Answer whether the receiver and the argument are the same.

Redefined in descendants as:

DateAndTime::isEqualTo() : comparand conforms to protocol DateAndTime, or can be converted into something that conforms.
Duration::isEqualTo() : Test if this Duration is equal to aDuration.
Time::isEqualTo() : comparand conforms to protocol DateAndTime, or can be converted into something that conforms.
Timespan::isEqualTo() : Test if this Timespan is equal to a Timespan.
Number::isEqualTo() : Answer whether the receiver and the argument are the same.

isGreaterThan (line 76)

Test if this is greater than aMagnitude.

since: 5/3/05
access: public

boolean isGreaterThan (object Magnitude $aMagnitude)

object Magnitude $aMagnitude

isGreaterThanOrEqualTo (line 100)

Test if this is greater than aMagnitude.

since: 5/3/05
access: public

boolean isGreaterThanOrEqualTo (object Magnitude $aMagnitude)

object Magnitude $aMagnitude

isLessThan (line 50)

Test if this is less than aMagnitude.

since: 5/4/05
access: public

boolean isLessThan (object Magnitude $aMagnitude)

object Magnitude $aMagnitude

Redefined in descendants as:

DateAndTime::isLessThan() : comparand conforms to protocol DateAndTime, or can be converted into something that conforms.
Duration::isLessThan() : Test if this Duration is less than aDuration.
Time::isLessThan() : comparand conforms to protocol DateAndTime, or can be converted into something that conforms.
Timespan::isLessThan() : Test if this Timespan is less than a comparand.
Number::isLessThan() : Test if this is less than aMagnitude.

isLessThanOrEqualTo (line 88)

Test if this is greater than aMagnitude.

since: 5/3/05
access: public

boolean isLessThanOrEqualTo (object Magnitude $aMagnitude)

object Magnitude $aMagnitude

max (line 127)

Answer the receiver or the argument, whichever has the greater magnitude.

since: 5/4/05
access: public

object Magnitude max (object Magnitude $aMagnitude)

object Magnitude $aMagnitude

min (line 143)

Answer the receiver or the argument, whichever has the lesser magnitude.

since: 5/4/05
access: public

object Magnitude min (object Magnitude $aMagnitude)

object Magnitude $aMagnitude

Inherited Methods

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()