001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2006-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.temporal;
033    
034    import java.util.Collection;
035    import org.opengis.util.InternationalString;
036    import org.opengis.annotation.UML;
037    
038    import static org.opengis.annotation.Obligation.*;
039    import static org.opengis.annotation.Specification.*;
040    
041    
042    /**
043     * Provides a basis for defining temporal position within a day.
044     *
045     * @author Alexander Petkov
046     *
047     * @todo Retrofit in the referencing framework.
048     */
049    @UML(identifier="TM_Clock", specification=ISO_19108)
050    public interface Clock extends TemporalReferenceSystem {
051        /**
052         * Event used as the datum for this clock.
053         */
054        @UML(identifier="referenceEvent", obligation=MANDATORY, specification=ISO_19108)
055        InternationalString getReferenceEvent();
056    
057        /**
058         * Time of the reference Event for this clock, usually the origin of the clock scale.
059         */
060        @UML(identifier="ReferenceTime", obligation=MANDATORY, specification=ISO_19108)
061        ClockTime getReferenceTime();
062    
063        /**
064         * Provides the 24-hour local or UTC time that corresponds to the reference time.
065         */
066        @UML(identifier="utcReference", obligation=MANDATORY, specification=ISO_19108)
067        ClockTime getUTCReference();
068    
069        /**
070         * Converts UTC time to a time on this clock.
071         */
072        @UML(identifier="clkTrans", obligation=MANDATORY, specification=ISO_19108)
073        ClockTime clkTrans(ClockTime clkTime);
074    
075        /**
076         * Converts UTC time to a time on this clock.
077         */
078        @UML(identifier="utcTrans", obligation=MANDATORY, specification=ISO_19108)
079        ClockTime utcTrans(ClockTime uTime);
080    }