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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>visu_commandLine</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="core.html" title="Part I. Core">
<link rel="prev" href="VisuObject.html" title="VisuObject">
<link rel="next" href="v-sim-visu-basic.html" title="visu_basic">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="VisuObject.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="v-sim-visu-basic.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-visu-commandLine.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-visu-commandLine.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="visu_commandLine">
<a name="v-sim-visu-commandLine"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-visu-commandLine.top_of_page"></a>visu_commandLine</span></h2>
<p>visu_commandLine — All methods needed to parse options from the
command line.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-visu-commandLine.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">int</span> <a class="link" href="v-sim-visu-commandLine.html#commandLineParse" title="commandLineParse ()">commandLineParse</a> (<em class="parameter"><code><span class="type">int</span> argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-commandLine.html#commandLineExport" title="commandLineExport ()">commandLineExport</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">char</span>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-ArgFilename" title="commandLineGet_ArgFilename ()">commandLineGet_ArgFilename</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">char</span>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-ArgSpinFileName" title="commandLineGet_ArgSpinFileName ()">commandLineGet_ArgSpinFileName</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">char</span>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-ExportFileName" title="commandLineGet_ExportFileName ()">commandLineGet_ExportFileName</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">int</span> <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-WithGtk" title="commandLineGet_WithGtk ()">commandLineGet_WithGtk</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-XWindowGeometry" title="commandLineGet_XWindowGeometry ()">commandLineGet_XWindowGeometry</a> (<em class="parameter"><code><span class="type">int</span> *width</code></em>,
<em class="parameter"><code><span class="type">int</span> *height</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-colorizeFileName" title="commandLineGet_colorizeFileName ()">commandLineGet_colorizeFileName</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">int</span>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-colorizeColUsed" title="commandLineGet_colorizeColUsed ()">commandLineGet_colorizeColUsed</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
#define <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-colorizePresetColor" title="commandLineGet_colorizePresetColor">commandLineGet_colorizePresetColor</a>
<span class="returnvalue">int</span> <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-presetColor" title="commandLineGet_presetColor ()">commandLineGet_presetColor</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">float</span>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-translation" title="commandLineGet_translation ()">commandLineGet_translation</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">float</span>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-extension" title="commandLineGet_extension ()">commandLineGet_extension</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-planesFileName" title="commandLineGet_planesFileName ()">commandLineGet_planesFileName</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">int</span> <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-spinHidingMode" title="commandLineGet_spinHidingMode ()">commandLineGet_spinHidingMode</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-spinAndAtomic" title="commandLineGet_spinAndAtomic ()">commandLineGet_spinAndAtomic</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">float</span>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-isoValues" title="commandLineGet_isoValues ()">commandLineGet_isoValues</a> (<em class="parameter"><code><span class="type">int</span> *nb</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>** <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-isoNames" title="commandLineGet_isoNames ()">commandLineGet_isoNames</a> (<em class="parameter"><code><span class="type">int</span> *nb</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-scalarFieldFileName" title="commandLineGet_scalarFieldFileName ()">commandLineGet_scalarFieldFileName</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-isoSurfacesFileName" title="commandLineGet_isoSurfacesFileName ()">commandLineGet_isoSurfacesFileName</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-fitToBox" title="commandLineGet_fitToBox ()">commandLineGet_fitToBox</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-resourcesFile" title="commandLineGet_resourcesFile ()">commandLineGet_resourcesFile</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-options" title="commandLineGet_options ()">commandLineGet_options</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">int</span>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-coloredMap" title="commandLineGet_coloredMap ()">commandLineGet_coloredMap</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="v-sim-toolMatrix.html#ToolMatrixScalingFlag" title="enum ToolMatrixScalingFlag"><span class="returnvalue">ToolMatrixScalingFlag</span></a> <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-logScale" title="commandLineGet_logScale ()">commandLineGet_logScale</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-nIsoLines" title="commandLineGet_nIsoLines ()">commandLineGet_nIsoLines</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-bgImage" title="commandLineGet_bgImage ()">commandLineGet_bgImage</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">float</span>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-isoLinesColor" title="commandLineGet_isoLinesColor ()">commandLineGet_isoLinesColor</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-windowMode" title="commandLineGet_windowMode ()">commandLineGet_windowMode</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-iSet" title="commandLineGet_iSet ()">commandLineGet_iSet</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-valueFile" title="commandLineGet_valueFile ()">commandLineGet_valueFile</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-commandLine.html#commandLineFree-all" title="commandLineFree_all ()">commandLineFree_all</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-mapPrecision" title="commandLineGet_mapPrecision ()">commandLineGet_mapPrecision</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">float</span>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-mapMinMax" title="commandLineGet_mapMinMax ()">commandLineGet_mapMinMax</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-introspect" title="commandLineGet_introspect ()">commandLineGet_introspect</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-visu-commandLine.description"></a><h2>Description</h2>
<p>
</p>
<p>V_Sim parses the command line at startup and store data in
private variables. All this values can be retrieve later by the
program through calls to commandLineGet_* methods.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-visu-commandLine.details"></a><h2>Details</h2>
<div class="refsect2" title="commandLineParse ()">
<a name="commandLineParse"></a><h3>commandLineParse ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> commandLineParse (<em class="parameter"><code><span class="type">int</span> argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv</code></em>);</pre>
<p>
This method is called at startup to parse the command line
and store all important information. If --help is given, or an unknown
option, a little help is printed on the standard output.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>the number of arguments.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>the values of all arguments.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 0 if everything goes well.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineExport ()">
<a name="commandLineExport"></a><h3>commandLineExport ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> commandLineExport (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Export the known command line options to an XML file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a path to a filename to create ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a location to store a possible error.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="commandLineGet_ArgFilename ()">
<a name="commandLineGet-ArgFilename"></a><h3>commandLineGet_ArgFilename ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span>* commandLineGet_ArgFilename (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves the first argument. All other arguments are ignored.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of the first argument.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_ArgSpinFileName ()">
<a name="commandLineGet-ArgSpinFileName"></a><h3>commandLineGet_ArgSpinFileName ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span>* commandLineGet_ArgSpinFileName (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves the second argument. All other arguments are ignored.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of the second argument.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_ExportFileName ()">
<a name="commandLineGet-ExportFileName"></a><h3>commandLineGet_ExportFileName ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span>* commandLineGet_ExportFileName (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves the value of the option --export or -e. This value must
be a valid filename, with an extension known by V_Sim to do the export.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of the option --export.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_WithGtk ()">
<a name="commandLineGet-WithGtk"></a><h3>commandLineGet_WithGtk ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> commandLineGet_WithGtk (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method tells V_Sim is the GTK interface is needed or not.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if the interface is needed.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_XWindowGeometry ()">
<a name="commandLineGet-XWindowGeometry"></a><h3>commandLineGet_XWindowGeometry ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> commandLineGet_XWindowGeometry (<em class="parameter"><code><span class="type">int</span> *width</code></em>,
<em class="parameter"><code><span class="type">int</span> *height</code></em>);</pre>
<p>
This method retrieves the values of the option --geometry or -g.
These values must be formatted with the following format : &dx&d and they give
the size of the rendering window.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>an integer to stores the desired width.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>an integer to stores the desired height.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_colorizeFileName ()">
<a name="commandLineGet-colorizeFileName"></a><h3>commandLineGet_colorizeFileName ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* commandLineGet_colorizeFileName (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves the value of the option --colorize or -c. This value must
be a valid filename. If this option is called, V_Sim actually enable
the colorization, even if parameter file doesn't.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of the option --colorize.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_colorizeColUsed ()">
<a name="commandLineGet-colorizeColUsed"></a><h3>commandLineGet_colorizeColUsed ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>* commandLineGet_colorizeColUsed (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves the value of the option --use-column or -u. This value consists
of three integer values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the three values of the option --use-column, or NULL if this option
is not present.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_colorizePresetColor">
<a name="commandLineGet-colorizePresetColor"></a><h3>commandLineGet_colorizePresetColor</h3>
<pre class="programlisting">#define commandLineGet_colorizePresetColor() commandLineGet_presetColor();
</pre>
<p>
DEPRECATED, use <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-presetColor" title="commandLineGet_presetColor ()"><code class="function">commandLineGet_presetColor()</code></a> instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of option --color-preset if set, -1 if not.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_presetColor ()">
<a name="commandLineGet-presetColor"></a><h3>commandLineGet_presetColor ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> commandLineGet_presetColor (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method returns the value of option --color-preset.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of option --color-preset if set, -1 if not.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_translation ()">
<a name="commandLineGet-translation"></a><h3>commandLineGet_translation ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>* commandLineGet_translation (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves the value of the option --translate or -t. This value consists
of three floating values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the three values of the option --translate.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_extension ()">
<a name="commandLineGet-extension"></a><h3>commandLineGet_extension ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>* commandLineGet_extension (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves the value of the option --expand or -x. This value consists
of three floating values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the three values of the option --expand.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_planesFileName ()">
<a name="commandLineGet-planesFileName"></a><h3>commandLineGet_planesFileName ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* commandLineGet_planesFileName (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves the value of the option --planes or -p. This value must
be a valid filename.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of the option --planes.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_spinHidingMode ()">
<a name="commandLineGet-spinHidingMode"></a><h3>commandLineGet_spinHidingMode ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> commandLineGet_spinHidingMode (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves if the option --hiding-mode or -m has been set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of the option.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_spinAndAtomic ()">
<a name="commandLineGet-spinAndAtomic"></a><h3>commandLineGet_spinAndAtomic ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> commandLineGet_spinAndAtomic (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves if the option --spin-and-atomic or -a has been set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the TRUE if the option exists.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_isoValues ()">
<a name="commandLineGet-isoValues"></a><h3>commandLineGet_isoValues ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>* commandLineGet_isoValues (<em class="parameter"><code><span class="type">int</span> *nb</code></em>);</pre>
<p>
This method retrieves the values of the option --ios-values or -v.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nb</code></em> :</span></p></td>
<td>a location to store an integer.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an array with the values of a size stored in <em class="parameter"><code>nb</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_isoNames ()">
<a name="commandLineGet-isoNames"></a><h3>commandLineGet_isoNames ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>** commandLineGet_isoNames (<em class="parameter"><code><span class="type">int</span> *nb</code></em>);</pre>
<p>
This method retrieves the names associated to the values of the option --ios-values or -v.
It returns an array of size <em class="parameter"><code>nb</code></em>, but not all element are set since names are not
mandatory. The <em class="parameter"><code>nb</code></em> value is guarantied to by equal to the one returned by
commandLineGet_isoValues(void);
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nb</code></em> :</span></p></td>
<td>a location to store an integer.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an array with the values of a size stored in <em class="parameter"><code>nb</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_scalarFieldFileName ()">
<a name="commandLineGet-scalarFieldFileName"></a><h3>commandLineGet_scalarFieldFileName ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* commandLineGet_scalarFieldFileName (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves the filename given by the option --scalar-field or -f.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a filename, the string is owned by V_Sim.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_isoSurfacesFileName ()">
<a name="commandLineGet-isoSurfacesFileName"></a><h3>commandLineGet_isoSurfacesFileName ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* commandLineGet_isoSurfacesFileName (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method retrieves the filename given by the option --iso-surfaces or -i.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a filename, the string is owned by V_Sim.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_fitToBox ()">
<a name="commandLineGet-fitToBox"></a><h3>commandLineGet_fitToBox ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> commandLineGet_fitToBox (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method gets if the surface should be adapted to the bounding box of the structure.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the surface should be fitted.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_resourcesFile ()">
<a name="commandLineGet-resourcesFile"></a><h3>commandLineGet_resourcesFile ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* commandLineGet_resourcesFile (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method gets if a resources file has been given.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the name (owned by V_Sim) of the given resources file or NULL if none
was present.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_options ()">
<a name="commandLineGet-options"></a><h3>commandLineGet_options ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a>* commandLineGet_options (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method gets the contents of all -o options. The value is first parsed as
letters to check for a boolean value (F/T), then, a float is used and finally
an integer. If nothing parsed, the option is dismissed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> pointer owned by V_Sim.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_coloredMap ()">
<a name="commandLineGet-coloredMap"></a><h3>commandLineGet_coloredMap ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>* commandLineGet_coloredMap (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
If the return value is TRUE, then the user requests a coloured map
using the given plane. The scalar field is given by
'--scalar-filed' option (see <a class="link" href="v-sim-visu-commandLine.html#commandLineGet-scalarFieldFileName" title="commandLineGet_scalarFieldFileName ()"><code class="function">commandLineGet_scalarFieldFileName()</code></a>)
and the shade by '--color-preset' (see
<a class="link" href="v-sim-visu-commandLine.html#commandLineGet-presetColor" title="commandLineGet_presetColor ()"><code class="function">commandLineGet_presetColor()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>planeId</code></em> :</span></p></td>
<td>a location to store the plane to be used.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if a coloured map is requested.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_logScale ()">
<a name="commandLineGet-logScale"></a><h3>commandLineGet_logScale ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolMatrix.html#ToolMatrixScalingFlag" title="enum ToolMatrixScalingFlag"><span class="returnvalue">ToolMatrixScalingFlag</span></a> commandLineGet_logScale (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieve if a log scale is required for various plots.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the logscale method.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_nIsoLines ()">
<a name="commandLineGet-nIsoLines"></a><h3>commandLineGet_nIsoLines ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> commandLineGet_nIsoLines (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieve if the user asked for isolines on the coloured map (see
<a class="link" href="v-sim-visu-commandLine.html#commandLineGet-coloredMap" title="commandLineGet_coloredMap ()"><code class="function">commandLineGet_coloredMap()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a positive number if some isolines are required, 0 if not.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_bgImage ()">
<a name="commandLineGet-bgImage"></a><h3>commandLineGet_bgImage ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* commandLineGet_bgImage (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieve if the filename to be loaded as a background image.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string or NULL if option is not used.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="commandLineGet_isoLinesColor ()">
<a name="commandLineGet-isoLinesColor"></a><h3>commandLineGet_isoLinesColor ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>* commandLineGet_isoLinesColor (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieve the chosen colour for the iso-lines.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an array of three floats or NULL if the colour is auto.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="commandLineGet_windowMode ()">
<a name="commandLineGet-windowMode"></a><h3>commandLineGet_windowMode ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* commandLineGet_windowMode (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieve the windowing mode for V_Sim, 'classic' with the two
rendering and command panel windows ; 'oneWindow' with a joined
version of the two windows or 'renderOnly' with only the rendering window.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> one of the three strings.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="commandLineGet_iSet ()">
<a name="commandLineGet-iSet"></a><h3>commandLineGet_iSet ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> commandLineGet_iSet (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieve the desired id for multi dataset file to render.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 0 as default value.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="commandLineGet_valueFile ()">
<a name="commandLineGet-valueFile"></a><h3>commandLineGet_valueFile ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* commandLineGet_valueFile (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieve the name of a possible value file, if any has been given.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a path (absolute) or NULL if the option has not been
passed. Data are static.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="commandLineFree_all ()">
<a name="commandLineFree-all"></a><h3>commandLineFree_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> commandLineFree_all (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Release all allocated memory related to the command line options.
</p>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="commandLineGet_mapPrecision ()">
<a name="commandLineGet-mapPrecision"></a><h3>commandLineGet_mapPrecision ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> commandLineGet_mapPrecision (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
The coloured maps can be rendered with more or less accuracy.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the precision requested by the user.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="commandLineGet_mapMinMax ()">
<a name="commandLineGet-mapMinMax"></a><h3>commandLineGet_mapMinMax ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>* commandLineGet_mapMinMax (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
The coloured maps can be manually scaled.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the scaling values for manual scaling of coloured maps.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="commandLineGet_introspect ()">
<a name="commandLineGet-introspect"></a><h3>commandLineGet_introspect ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* commandLineGet_introspect (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Used only by introspection scanner.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the parameters of the introspection option.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
