location-definitions.h

Go to the documentation of this file.

/* WOSS - World Ocean Simulation System -
 * 
 * Copyright (C) 2009 Federico Guerra
 * and regents of the SIGNET lab, University of Padova
 *
 * Author: Federico Guerra - federico@guerra-tlc.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */ 
 
/*
 * This software has been developed by Federico Guerra and SIGNET lab,
 * University of Padova, in collaboration with the NATO Centre for 
 * Maritime Research and Experimentation (http://www.cmre.nato.int ; 
 * E-mail: pao@cmre.nato.int), whose support is gratefully acknowledged.
 */
 
 
#ifndef LOCATION_DEFINITIONS_H
#define LOCATION_DEFINITIONS_H 
 
 
#include <cmath>
#include "coordinates-definitions.h"
#include <iostream>
 
 
namespace woss {
  
  
  #define LOCATION_COMPARISON_DISTANCE (0.0)
  
  
  class Location {
  
  
    public:
      
 
    Location( const CoordZ& coordz = CoordZ(), double dist = LOCATION_COMPARISON_DISTANCE );
      
    Location( double latitude, double longitude, double depth = 0, double dist = LOCATION_COMPARISON_DISTANCE );
    
    virtual ~Location() { }
    
    virtual Location* create( double latitude, double longitude, double depth = 0, double dist = LOCATION_COMPARISON_DISTANCE ) const { 
      return new Location(latitude, longitude, depth, dist); }
 
    virtual Location* create( const CoordZ& coordz = CoordZ(), double dist = LOCATION_COMPARISON_DISTANCE ) const { 
      return new Location(coordz,dist); }
    
    virtual Location* clone() const { return new Location(*this); }
 
 
    virtual bool isValid() const { return curr_coordz.isValid(); }
    
 
    virtual bool isEquivalentTo( const woss::CoordZ& coordz ); 
    
  
    virtual void setLocation( const CoordZ& coordz );
    
    virtual void setLatitude( double lat ); 
  
    virtual void setLongitude( double lon );
 
    virtual void setDepth( double depth );
    
    
    virtual void setVerticalOrientation( double angle );
    
    virtual void setHorizontalOrientation( double angle );
    
    
    virtual CoordZ getLocation(); 
 
    virtual double getLatitude(); 
    
    virtual double getLongitude(); 
 
    virtual double getDepth(); 
 
 
    virtual double getX(); 
    
    virtual double getY(); 
    
    virtual double getZ();
    
    virtual double getVerticalOrientation();
    
    virtual double getHorizontalOrientation();
  
    virtual double getBearing();
    
    
    friend ::std::ostream& operator<<( ::std::ostream& os, const Location& instance ) {
      os << "Location, latitude = " << instance.curr_coordz.getLatitude() << "; longitude = " << instance.curr_coordz.getLongitude()
         << "; depth = " << instance.curr_coordz.getDepth();
      return os;
    }
 
  
    protected:
      
    
    double comparison_distance;
    
    
    CoordZ curr_coordz;
    
    
    double vertical_orientation;
 
    double horizontal_orientation;
 
    double bearing;
    
    
  };
  
  
}
 
 
#endif /* LOCATION_DEFINITIONS_H */