1AGGETP(3NCARG)                   NCAR GRAPHICS                  AGGETP(3NCARG)
2
3
4

NAME

6       AGGETP - Allows a user program to get the values of a group of
7       parameters containing one or more elements.
8

SYNOPSIS

10       CALL AGGETP (TPGN,FURA,LURA)
11

C-BINDING SYNOPSIS

13       #include <ncarg/ncargC.h>
14
15       void c_aggetp (char *tpgn, float *fura, int lura)
16

DESCRIPTION

18       TPGN        (an input expression of type CHARACTER) is a character
19                   string of the form 'k1/k2/ . . . kn.', where each of the
20                   ki's is a keyword. The keyword k1 specifies a group of
21                   parameters, k2 a subgroup of that group, k3 a subgroup of
22                   that subgroup, etc. The whole string is the name of some
23                   group of parameters the user wishes to set.
24
25                   For example, 'AXIS.' is the name of a 92-word group of
26                   parameters describing the four axes, 'AXIS/RIGHT.' is the
27                   name of a 23-word subgroup describing the right Y axis,
28
29                        'AXIS/RIGHT/INTERSECTION.'
30
31                   is the name of a 2-word further subgroup describing the
32                   intersection of the right Y axis with the bottom of the
33                   grid window, and
34
35                        'AXIS/RIGHT/INTERSECTION/USER.'
36
37                   is the name of a single parameter specifying the point of
38                   intersection of the right Y axis with the bottom of the
39                   grid window as an X coordinate in the user coordinate
40                   system.
41
42                   Obviously, these names can sometimes become rather long.
43                   There are various ways in which they may be shortened.
44                   First, since the fifth and following characters of each
45                   keyword are ignored, they may be omitted; this would
46                   shorten
47
48                        'AXIS/RIGHT/INTERSECTION/USER.'
49
50                   to
51
52                        'AXIS/RIGH/INTE/USER.'
53
54                   Even fewer characters may be used, as long as no ambiguity
55                   of interpretation arises. To be completely safe, use at
56                   least the first three characters of the group keyword and
57                   at least the first two characters of each subgroup keyword;
58                   this would shorten the example above to 'AXI/RI/IN/US.'.
59                   Moreover, certain group and subgroup keywords may be
60                   omitted entirely; for example, 'AXI/RI/IN/US.' may be
61                   shortened to 'RI/IN/US.'. Keywords which may be entirely
62                   omitted are enclosed in brackets in the headings in the
63                   section "PARAMETERS".
64
65                   Names may also be lengthened in various ways in order to
66                   improve their readability. Blanks may be used as desired on
67                   either side of a keyword. Any sequence of characters not
68                   including a slash or a period may be inserted after a
69                   keyword, separated from it by at least one blank. For
70                   example, the name
71
72                        'DASH PATTERN / CHARACTER WIDTH .'
73
74                   is equivalent to, and considerably more meaningful than,
75
76                        'DAS/CH.' (or even 'DASH/CHARACTER.')
77
78
79       FURA        (an input array of type REAL, dimensioned LURA) contains
80                   new values for the parameters in the group specified by
81                   TPGN, in the same order as they appear in the group. All
82                   parameters have real values (because of a portability
83                   problem which arose in implementing the routines AGSETF and
84                   AGSETR). Those which represent intrinsically integral
85                   quantities have a value of the form "FLOAT(n)", where "n"
86                   is the integral quantity being represented. Some parameters
87                   intrinsically take on character-string values; the real
88                   quantity stored as the value of such a parameter is
89                   typically an identifier allowing for later retrieval of the
90                   character string from a character storage area inside
91                   Autograph. The routines AGSETC and AGGETC may be used to
92                   set/get the character-string values of such parameters.
93
94       LURA        (an input expression of type INTEGER) is the length of
95                   FURA. Its value may be less than, equal to, or greater
96                   than, the length of the group specified by TPGN. The number
97                   of values transferred into FURA is the minimum of the two
98                   (but not less than one). You may, for example, get the
99                   first two parameters of a 100-parameter group by using LURA
100                   = 2.
101

C-BINDING DESCRIPTION

103       The C-binding argument description is the same as the FORTRAN argument
104       description.
105

USAGE

107       This routine allows you to retrieve the current value of Autograph
108       parameters.  For a complete list of parameters available in this
109       utility, see the autograph_params man page.
110

ACCESS

112       To use AGGETP or c_aggetp, load the NCAR Graphics libraries ncarg,
113       ncarg_gks, and ncarg_c, preferably in that order.    To get smoother
114       curves, drawn using spline interpolation, also load libdashsmth.o.  Or,
115       you can use the ncargf77 command to compile your program and load the
116       above libraries, then, to get smoother curves, use the -dashsmth
117       option.
118

MESSAGES

120       See the autograph man page for a description of all Autograph error
121       messages and/or informational messages.
122

SEE ALSO

124       Online: autograph, autograph_params, agback, agbnch, agchax, agchcu,
125       agchil, agchnl, agcurv, agdshn, aggetc, aggetf, aggeti, aggetr, agpwrt,
126       agrstr, agsave, agsetc, agsetf, agseti, agsetp, agsetr, agstup, agutol,
127       anotat, displa, ezmxy, ezmy, ezxy, ezy
128
129       Hardcopy: NCAR Graphics Fundamentals, UNIX Version
130
132       Copyright (C) 1987-2009
133       University Corporation for Atmospheric Research
134       The use of this Software is governed by a License Agreement.
135
136
137
138UNIX                              March 1993                    AGGETP(3NCARG)
Impressum