blob: a2bb93baac20614e3dd9c09639b748c00b621762 (
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
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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="atomsIsLoaded">
<refnamediv>
<refname>atomsIsLoaded</refname>
<refpurpose>determines whether a module is loaded or not</refpurpose>
</refnamediv>
<!-- ===================================================================== -->
<!-- Calling Sequence -->
<!-- ===================================================================== -->
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
result = atomsIsLoaded(modules)
</synopsis>
</refsynopsisdiv>
<!-- ===================================================================== -->
<!-- Parameters -->
<!-- ===================================================================== -->
<refsection>
<title>Arguments</title>
<variablelist>
<!-- 1st input parameter -->
<varlistentry>
<term>modules</term>
<listitem>
<para>
mx1, mx2 Matrix of strings:
</para>
<informaltable border="1">
<!-- Technical name -->
<tr>
<td>
<emphasis>1st Col.</emphasis>
</td>
<td>
<emphasis role="strong">Technical name</emphasis>
</td>
<td>
Mandatory
</td>
<td>
</td>
</tr>
<!-- Version -->
<tr>
<td>
<emphasis>2nd Col.</emphasis>
</td>
<td>
<emphasis role="strong">Version</emphasis>
</td>
<td>
Optional
</td>
<td>
If this field is empty or is not present,
module's version is ignored.
</td>
</tr>
<!-- Section -->
<tr>
<td>
<emphasis>3rd Col.</emphasis>
</td>
<td>
<emphasis role="strong">Section</emphasis>
</td>
<td>
Optional
</td>
<td>
If this field is empty or is not present,
module's section is ignored.
</td>
</tr>
</informaltable>
</listitem>
</varlistentry>
<!-- Output parameter -->
<varlistentry>
<term>result</term>
<listitem>
<para>
mx1 boolean matrix
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<!-- ===================================================================== -->
<!-- Description -->
<!-- ===================================================================== -->
<refsection>
<title>Description</title>
<para>
<literal>atomsIsLoaded</literal> determines whether a module is loaded or not.
</para>
</refsection>
<!-- ===================================================================== -->
<!-- Examples -->
<!-- ===================================================================== -->
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
atomsSetConfig("Verbose","True");
atomsRepositoryAdd("http://scene2.test.atoms.scilab.org");
// Install toolbox_4, both 1.0 and 1.1 version
atomsInstall(["toolbox_4" "1.0"],"user");
// Load the version 1.0
atomsLoad(["toolbox_4" "1.0"]);
// Ignore the module's version
atomsIsLoaded("toolbox_4")
// With a specific version
atomsIsLoaded(["toolbox_4" "1.0"])
// Check several modules
atomsIsLoaded( ["toolbox_4" "1.0" ; "toolbox_4" "1.1" ; "toolbox_1" "1.0" ] )
// Some cleaning ...
atomsRepositoryDel("http://scene2.test.atoms.scilab.org");
atomsRemove("toolbox_2");
]]></programlisting>
</refsection>
<!-- ===================================================================== -->
<!-- See also -->
<!-- ===================================================================== -->
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="atomsLoad">atomsLoad</link>
</member>
<member>
<link linkend="atomsGetLoaded">atomsGetLoaded</link>
</member>
</simplelist>
</refsection>
<!-- ===================================================================== -->
<!-- Authors -->
<!-- ===================================================================== -->
</refentry>
|
