summaryrefslogtreecommitdiffstats
path: root/kabc/geo.h
blob: cac6abaff93868d494cfbfaf01ca8a2ab044a15d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/*
    This file is part of libkabc.
    Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KABC_GEO_H
#define KABC_GEO_H

#include <tqstring.h>

#include <tdelibs_export.h>

namespace KABC {

/**
  @short Geographic position
  
  This class represents a geographic position.
*/
class KABC_EXPORT Geo
{
    friend KABC_EXPORT TQDataStream &operator<<( TQDataStream &, const Geo & );
    friend KABC_EXPORT TQDataStream &operator>>( TQDataStream &, Geo & );

  public:
    /**
      Construct invalid geographics position object.
    */
    Geo();

    /**
      Construct geographics position object.
      
      @param latitude  Geographical latitude
      @param longitude Geographical longitude
    */
    Geo( float latitude, float longitude );
    
    /**
      Sets the latitude.
    */
    void setLatitude( float );

    /**
      Returns the latitude.
    */
    float latitude() const;
    
    /**
      Sets the longitude.
    */
    void setLongitude( float );

    /**
      Returns the longitude.
    */
    float longitude() const;
  
    /**
      Returns, if this object contains a valid geographical position.
    */
    bool isValid() const;
    
    bool operator==( const Geo & ) const;
    bool operator!=( const Geo & ) const;

    /**
      Returns string representation of geographical position.
    */
    TQString asString() const;
      
  private:
    float mLatitude;
    float mLongitude;
    
    bool mValid;
    bool mValidLat;
    bool mValidLong;
};

KABC_EXPORT TQDataStream &operator<<( TQDataStream &, const Geo & );
KABC_EXPORT TQDataStream &operator>>( TQDataStream &, Geo & );

}

#endif