Projection.java

/*
    GNU General Public License
    CacheWolf is a software for PocketPC, Win and Linux that
    enables paperless caching.
    It supports the sites geocaching.com and opencaching.de

    Copyright (C) 2006  CacheWolf development team
	See http://www.cachewolf.de/ for more information.
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; version 2 of the License.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
package CacheWolf.navi;

import CacheWolf.database.CWPoint;

abstract class Projection {
    /** in Implementation: <br>
     * a) if the projection covers only one epsgCode (== one zone)<br>
     * b) if the projection covers different epsgCodes (== different zones)<br> 
     * put here the calculation from zone number to the epsgCode(s) (method getEpsgcode)
     */
    public int epsgCode;
    public boolean zoneSeperately = false;

    /**
     * The zone is automatically determined
     * rember to set the zone in pp when you implement this method 
     * @param ll
     * @param pp: pp will be filled with the projected ll. If null, a new ProjectedPoint will be created
     * @return
     */
    public abstract ProjectedPoint project(CWPoint wgs84, ProjectedPoint pp);

    /**
     * Zone is fixed by epsg-code
     * @param ll
     * @param pp
     * @param epsg
     * @return
     */
    public abstract ProjectedPoint project(CWPoint ll, ProjectedPoint pp, int epsg);

    /**
     * unproject
     * @param pp
     * @return
     */
    public abstract CWPoint unproject(ProjectedPoint pp);

    /**
     * Returns the projected Northing in local notation
     * @param pp
     * @return
     */
    public abstract double getNorthing(ProjectedPoint pp);

    /**
     * Returns the projected Easting in local notation
     * @param pp
     * @return
     */
    public abstract double getEasting(ProjectedPoint pp);

    /**
     * set by
     * @param northing
     * @param easting
     * @param pp
     * @return
     */
    public ProjectedPoint set(double northing, double easting, ProjectedPoint pp) {
	throw new UnsupportedOperationException("Projection.set: set() requires zone, use set with 1 more parameter");
    }

    /**
     * set by
     * @param northing
     * @param easting
     * @param zone
     * @param pp
     * @return
     */
    public ProjectedPoint set(double northing, double easting, String zone, ProjectedPoint pp) {
	throw new UnsupportedOperationException("Projection.set (double, double String, ProjectedPoint): This projection uses no seperate zones");
    }

    /**
     * Returns Zone
     * @param pp
     * @return
     */
    public String getZone(ProjectedPoint pp) {
	throw new UnsupportedOperationException("Projection.getZone (double, double String, ProjectedPoint): This projection uses no seperate zones");
    }

    /**
     * Returns EPSGCode
     * @param pp
     * @return
     */
    public int getEpsgcode(ProjectedPoint pp) {
	return epsgCode + pp.zone;
    }

    /**
     * In case the same Projection-class is used for several epsg codes,<br>
     * this method translates the localsystem to the corresponding epsg code.<br>
     *   
     * It is used by UTMProjectionFixZone<br>
     * which can be used to project all epsg codes which represent just one UTM stripe, like Sweden.<br> 
     * ProjectedPoint sets projection.epsgCode, if it is zero.<br>
     * @param localsystem
     * @return
     */
    public int getEpsgcode(int localsystem) {
	throw new UnsupportedOperationException("Projection.getEpsg(localsystem): This projection has getEpsg not implemented.");
    }

}