org.geotools.temporal.reference
Class DefaultClock

Object
  extended by DefaultTemporalReferenceSystem
      extended by DefaultClock
All Implemented Interfaces:
IdentifiedObject, ReferenceSystem, Clock, TemporalReferenceSystem

public class DefaultClock
extends DefaultTemporalReferenceSystem
implements Clock

Author:
Mehdi Sidhoum (Geomatys)

Field Summary
 
Fields inherited from interface ReferenceSystem
DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
 
Fields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
 
Constructor Summary
DefaultClock(ReferenceIdentifier name, Extent domainOfValidity, InternationalString referenceEvent, ClockTime referenceTime, ClockTime utcReference)
           
 
Method Summary
 ClockTime clkTrans(ClockTime uTime)
          Takes a 24-hour local or UTC time and return the equivalent time of day expressed in terms of the specified clock.
 boolean equals(Object object)
           
 Collection<Calendar> getDateBasis()
           
 InternationalString getReferenceEvent()
          Event used as the datum for this clock.
 ClockTime getReferenceTime()
          Time of the reference Event for this clock, usually the origin of the clock scale.
 ClockTime getUTCReference()
          Provides the 24-hour local or UTC time that corresponds to the reference time.
 int hashCode()
           
 void setReferenceEvent(InternationalString referenceEvent)
           
 void setReferenceTime(ClockTime referenceTime)
           
 void setUtcReference(ClockTime utcReference)
           
 String toString()
           
 ClockTime utcTrans(ClockTime clkTime)
          Takes a time of day expressed in terms of the specified clock and return the equivalent time of day in 24-hour local or UTC time.
 
Methods inherited from class DefaultTemporalReferenceSystem
getAlias, getDomainOfValidity, getIdentifiers, getName, getRemarks, getScope, getValidArea, setDomainOfValidity, setName, setScope, setValidArea, toWKT
 
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface TemporalReferenceSystem
getDomainOfValidity, getName
 
Methods inherited from interface ReferenceSystem
getScope
 
Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getRemarks, toWKT
 

Constructor Detail

DefaultClock

public DefaultClock(ReferenceIdentifier name,
                    Extent domainOfValidity,
                    InternationalString referenceEvent,
                    ClockTime referenceTime,
                    ClockTime utcReference)
Method Detail

getReferenceEvent

public InternationalString getReferenceEvent()
Description copied from interface: Clock
Event used as the datum for this clock.

Specified by:
getReferenceEvent in interface Clock

getReferenceTime

public ClockTime getReferenceTime()
Description copied from interface: Clock
Time of the reference Event for this clock, usually the origin of the clock scale.

Specified by:
getReferenceTime in interface Clock

getUTCReference

public ClockTime getUTCReference()
Description copied from interface: Clock
Provides the 24-hour local or UTC time that corresponds to the reference time.

Specified by:
getUTCReference in interface Clock

clkTrans

public ClockTime clkTrans(ClockTime uTime)
Takes a 24-hour local or UTC time and return the equivalent time of day expressed in terms of the specified clock.

Specified by:
clkTrans in interface Clock
Parameters:
uTime -
Returns:

utcTrans

public ClockTime utcTrans(ClockTime clkTime)
Takes a time of day expressed in terms of the specified clock and return the equivalent time of day in 24-hour local or UTC time.

Specified by:
utcTrans in interface Clock
Parameters:
clkTime -
Returns:

setReferenceEvent

public void setReferenceEvent(InternationalString referenceEvent)

setReferenceTime

public void setReferenceTime(ClockTime referenceTime)

setUtcReference

public void setUtcReference(ClockTime utcReference)

getDateBasis

public Collection<Calendar> getDateBasis()

equals

public boolean equals(Object object)
Overrides:
equals in class DefaultTemporalReferenceSystem

hashCode

public int hashCode()
Overrides:
hashCode in class DefaultTemporalReferenceSystem

toString

public String toString()
Overrides:
toString in class DefaultTemporalReferenceSystem


Copyright © 1996-2014 Geotools. All Rights Reserved.