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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
.\"##
.\" $XConsortium: p221,v 5.2 94/04/17 20:57:00 rws Exp $
.\"##
.\"##
$XMCOPY
.\"## Copyright (c) 1990, 1991 by Sun Microsystems, Inc.
.\"##
.\"## All Rights Reserved
.\"##
.\"## Permission to use, copy, modify, and distribute this software and its
.\"## documentation for any purpose and without fee is hereby granted,
.\"## provided that the above copyright notice appear in all copies and that
.\"## both that copyright notice and this permission notice appear in
.\"## supporting documentation, and that the name of Sun Microsystems,
.\"## not be used in advertising or publicity
.\"## pertaining to distribution of the software without specific, written
.\"## prior permission.
.\"##
.\"## SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
.\"## INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\"## EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\"## CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\"## USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\"## OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\"## PERFORMANCE OF THIS SOFTWARE.
.ds f \s-2INQUIRE VALUATOR DEVICE STATE 3\s+2
.TH "INQUIRE VALUATOR DEVICE STATE 3" 3P "29 February 1991"
.SH NAME
INQUIRE VALUATOR DEVICE STATE 3 \- inquire state of a valuator device
.IX "Valuator Input Devices" "INQUIRE VALUATOR DEVICE STATE 3"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_val_st3 ( ws, dev, store, err, op_mode, echo_switch, init_value, prompt_echo,
echo_vol, val_data)
Pint ws; \fIworkstation identifier\fP
Pint dev; \fIvaluator device number\fP
Pstore store; \fIhandle to store object\fP
Pint *err; \fIOUT error indicator\fP
Pop_mode *op_mode; \fIOUT operating mode\fP
Pecho_switch *echo_switch; \fIOUT echo switch\fP
Pfloat *init_value; \fIOUT initial value\fP
Pint *prompt_echo; \fIOUT prompt/echo type\fP
Plimit3 *echo_vol; \fIOUT echo area\fP
Pval_data3 **val_data; \fIOUT data record\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
Use \*f to retrieve the current state of the specified valuator device.
.SS C Input Parameters
Applications using the \s-2C\s+2 binding must create a buffer to be used by this
function as memory space for storing data associated with the device state.
This buffer is passed as the \fIstore\fP argument.
.LP
The store buffer is a data area managed by the \s-2PHIGS\s+2. While the
application is responsible for creating the initial buffer through a call to
\s-2CREATE STORE\s+2, \s-2PHIGS\s+2 manages this area such that there is
sufficient memory for the specific inquiry. The valuator device data record
within the store buffer is accessed via the pointer pointed to by \fIval_data\fR.
.IP \fIws\fP
Workstation identifier. An integer specifying the workstation with which
the specified valuator device is associated.
.IP \fIdev\fP
The device number of the valuator device.
See the \fIAvailable Devices\fP section of \s-2INITIALIZE VALUATOR\s+2
for a description of the available devices.
.IP \fIstore\fP
The memory buffer \s-2PHIGS\s+2 is to use for storing the information
returned.
This buffer must exist prior to calling this function (see
\s-2CREATE STORE (3P)\s+2).
.SS C Output Parameters
.IP \fIerr\fP
A pointer to the location to store the error number of any error detected by this function.
.IP \fIop_mode\fP
The operating mode. Pop_mode is an enumerated type defined in phigs.h
with the following values:
.ta .5i
.nf
.sp .4
typedef enum {
.sp .2
POP_REQ,
POP_SAMPLE,
POP_EVENT
.sp .2
} Pop_mode;
.fi
.bp
.IP \fIecho_switch\fP
The echo state. Pecho_switch is an enumerated type defined in phigs.h
with the following values:
.ta .5i
.nf
.sp .4
typedef enum {
.sp .2
PSWITCH_NO_ECHO,
PSWITCH_ECHO
.sp .2
} Pecho_switch;
.fi
.IP \fIinit_value\fP
Initial value.
.IP \fIprompt_echo\fP
The prompt/echo type desired.
See the \fIAvailable Devices\fP Section of \s-2INITIALIZE VALUATOR\s+2
for a description of the available types.
.IP \fIecho_vol\fP
A pointer to a Plimit3 structure defining the
\fIx\fP, \fIy\fP, and \fIz\fP
components of the echo volume, in Device Coordinates.
Plimit3 is defined in phigs.h as follows:
.sp .4
.ta .5i +1i +1i
.nf
typedef struct {
.sp .2
Pfloat x_min; /* minimum x coordinate value */
Pfloat x_max; /* maximum x coordinate value */
Pfloat y_min; /* minimum y coordinate value */
Pfloat y_max; /* maximum y coordinate value */
Pfloat z_min; /* minimum z coordinate value */
Pfloat z_max; /* maximum z coordinate value */
.sp .2
} Plimit3;
.fi
.IP \fIval_data\fP
Pointer to a pointer that points to the pick device state within \fIstore\fR.
Pval_data3 is defined in phigs.h as follows:
.sp .4
.nf
.ta .5i +.5i +.5i +.5i
.sp .2
typedef struct {
.sp .2
Pfloat low; /* low range limit */
Pfloat high; /* high range limit */
union {
struct {
Pint unused;
} pet_r1;
struct {
char *label;
char *format;
char *low_label;
char *high_label;
} pet_u1;
} pets;
.sp .2
} Pval_data3;
.fi
.SS Execution
\*f returns the current state of the
specified valuator device, which is stored in the workstation
state list of the workstation associated with the device. The
current state includes the operating mode, echo switch, initial value,
prompt/echo type, echo volume, and data record.
See \s-2SET VALUATOR MODE\s+2 for a description of the operating mode and the
echo switch, and how to set these values.
See \s-2INITIALIZE VALUATOR 3\s+2 for a description of the initial valuator,
prompt/echo type, echo volume, and data record contents, and how to set these
values.
.LP
In the event of an error, the \fIerror indicator\fP
indicates the error number of the error detected, and no other output data
is returned. If no error is detected, the \fIerror indicator\fP
is set to zero, and the inquired information will be available in the output
parameters. Since this is an inquiry function, \s-2ERROR HANDLING\s+2 is not
invoked when an error is detected by this function.
.SH ERRORS
.IP 003
Ignoring function, function requires state
(\s-2PHOP\s+2, \s-2WSOP\s+2, \s-2*\s+2, \s-2*\s+2)
.IP 054
Ignoring function, the specified workstation is not open
.IP 061
Ignoring function, specified workstation is not of category \s-2INPUT\s+2
or \s-2OUTIN\s+2
.IP 250
Ignoring function, the specified device is not available
on the specified workstation
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INITIALIZE VALUATOR 3 (3P)"
.SM "SET VALUATOR MODE (3P)"
.SM "INQUIRE VALUATOR DEVICE STATE (3P)"
.SM "CREATE STORE (3P)"
.SM "DELETE STORE (3P)"
.fi
|
