← Back to branch summary

~ubuntu-branches/ubuntu/raring/geotranz/raring

« back to all changes in this revision

Viewing changes to geotrans2/src/source.h

  • Committer: Bazaar Package Importer
  • Author(s): Roberto Lumbreras
  • Date: 2008-10-17 14:43:09 UTC
  • Revision ID: james.westby@ubuntu.com-20081017144309-jb7uzfi1y1lvez8j
Tags: upstream-2.4.2
Import upstream version 2.4.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
geotrans2/src/source.h
 
1
#ifndef SOURCE_H
 
2
#define SOURCE_H
 
3
 
 
4
/***************************************************************************/
 
5
/* RSC IDENTIFIER: Source
 
6
 *
 
7
 * ABSTRACT
 
8
 * ERROR HANDLING
 
9
 *
 
10
 *    This component checks for input file errors and input parameter errors.
 
11
 *    If an invalid value is found, the error code is combined with the current
 
12
 *    error code using the bitwise or.  This combining allows multiple error
 
13
 *    codes to be returned. The possible error codes are:
 
14
 *
 
15
 *  SOURCE_NO_ERROR                  : No errors occurred in function
 
16
 *  SOURCE_INVALID_INDEX_ERROR       : Index out of valid range (less than one
 
17
 *                                      or more than Source_Count)
 
18
 *  SOURCE_INVALID_NAME_ERROR        : Source name not found
 
19
 *
 
20
 *
 
21
 * REUSE NOTES
 
22
 *
 
23
 *    Source is intended for reuse by any application that needs access to 
 
24
 *    accuracy sources.
 
25
 *
 
26
 *    
 
27
 * REFERENCES
 
28
 *
 
29
 *    Further information on Datum can be found in the Reuse Manual.
 
30
 *
 
31
 *    Source originated from :  U.S. Army Topographic Engineering Center (USATEC)
 
32
 *                              Geospatial Information Division (GID)
 
33
 *                              7701 Telegraph Road
 
34
 *                              Alexandria, VA  22310-3864
 
35
 *
 
36
 * LICENSES
 
37
 *
 
38
 *    None apply to this component.
 
39
 *
 
40
 * RESTRICTIONS
 
41
 *
 
42
 *    Source has no restrictions.
 
43
 *
 
44
 * ENVIRONMENT
 
45
 *
 
46
 *    Source was tested and certified in the following environments:
 
47
 *
 
48
 *    1. Solaris 2.5 with GCC 2.8.1
 
49
 *    2. MS Windows 95 with MS Visual C++ 6
 
50
 *
 
51
 * MODIFICATIONS
 
52
 *
 
53
 *    Date              Description
 
54
 *    ----              -----------
 
55
 */
 
56
 
 
57
 
 
58
/***************************************************************************/
 
59
/*
 
60
 *                              DEFINES
 
61
 */
 
62
 
 
63
#define SOURCE_NO_ERROR                          0x00000
 
64
#define SOURCE_INVALID_INDEX_ERROR               0x00001
 
65
#define SOURCE_INVALID_NAME_ERROR                0x00002
 
66
 
 
67
 
 
68
/***************************************************************************/
 
69
/*
 
70
 *                            FUNCTION PROTOTYPES
 
71
 */
 
72
 
 
73
/* ensure proper linkage to c++ programs */
 
74
#ifdef __cplusplus 
 
75
extern "C" {
 
76
#endif
 
77
 
 
78
void Source_Count (long *Count);
 
79
 
 
80
/*
 
81
 *  The function Source_Count returns the number of accuracy sources 
 
82
 *
 
83
 *  Count                : number of accuracy sources      (output)
 
84
 */
 
85
 
 
86
 
 
87
long Source_Index(const char *Name,
 
88
                  long *Index );
 
89
 
 
90
/*
 
91
 *  The function Source_Index returns the index of the accuracy source with the 
 
92
 *  specified name.
 
93
 *
 
94
 *  Name    : The source name being searched for.                   (input)
 
95
 *  Index   : The index of the accuracy source with the             (output)
 
96
 *              specified code.
 
97
 */
 
98
 
 
99
 
 
100
long Source_Name (const long Index,
 
101
                  char *Name);
 
102
/*
 
103
 *  The function Source_Name returns the name of the accuracy source referenced by
 
104
 *  index.
 
105
 *
 
106
 *  Index   : The index of a given datum in the datum table.        (input)
 
107
 *  Name    : The accuracy source Name referenced by Index.         (output)
 
108
 */
 
109
 
 
110
 
 
111
long Source_Accuracy (const long Index, 
 
112
                                                    double *CE,
 
113
                                                    double *LE,
 
114
                                                    double *SE);
 
115
/*
 
116
 *   The function Source_Accuracy returns the accuracy values (CE, LE, SE)
 
117
 *   for the source referenced by index.
 
118
 *
 
119
 *    Index      : The index of a given datum in the datum table   (input)
 
120
 *    CE         : Circular error                                  (output)
 
121
 *    LE         : Linear error                                    (output)
 
122
 *    SE         : Spherical error                                 (output)
 
123
 */
 
124
 
 
125
 
 
126
#ifdef __cplusplus 
 
127
}
 
128
#endif
 
129
 
 
130
#endif /* SOURCE_H */