001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2005-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.coverage.grid;
033    
034    import java.util.Set;
035    import org.opengis.coverage.ValueObject;
036    import org.opengis.coverage.DomainObject;
037    import org.opengis.geometry.Geometry;
038    import org.opengis.annotation.UML;
039    
040    import static org.opengis.annotation.Obligation.*;
041    import static org.opengis.annotation.Specification.*;
042    
043    
044    /**
045     * Basis for interpolating within a {@linkplain HexagonalGridCoverage continuous hexagonal grid
046     * coverage}. A {@code ValueHexagon} is a collection of {@linkplain GridPointValuePair grid-point
047     * value pairs} with a geometric structure.
048     *
049     * @version ISO 19123:2004
050     * @author  Alessio Fabiani
051     * @author  Martin Desruisseaux (IRD)
052     * @since   GeoAPI 2.1
053     */
054    @UML(identifier="CV_ValueHexagon", specification=ISO_19123)
055    public interface ValueHexagon extends ValueObject {
056        /**
057         * Returns the geometry of the value hexagon centred on the {@linkplain GridPointValuePair
058         * grid point-value pairs} identified by the {@linkplain #getControlValues control values}.
059         */
060        @UML(identifier="geometry", obligation=MANDATORY, specification=ISO_19123)
061        DomainObject<Geometry> getGeometry();
062    
063        /**
064         * Returns the <var>grid point</var>-<var>value</var> pairs at the {@code ValueHexagon} centre.
065         */
066        @UML(identifier="controlValue", obligation=MANDATORY, specification=ISO_19123)
067        Set<GridPointValuePair> getControlValues();
068    }