* Bug 16145 fixed: intg() integrate() intc() default atol
[scilab.git] / scilab / modules / hdf5 / help / en_US / h5is_checks / h5isRef.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!--
3 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4 * Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET
5 *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14 *
15 -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isRef" xml:lang="en">
17     <refnamediv>
18         <refname>h5isRef</refname>
19         <refpurpose>Check if the HDF5 object is a reference object</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>
24             b = h5isRef(obj)
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>obj</term>
32                 <listitem>
33                     <para>a H5Object</para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>b</term>
38                 <listitem>
39                     <para>a boolean</para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>Description</title>
46         <para>Check if an HDF5 object is a reference object.</para>
47     </refsection>
48     <refsection>
49         <title>Examples</title>
50         <programlisting role="example"><![CDATA[
51 // Create a SOD file which an HDF5 one
52 x = list(1, "hello");
53 save(TMPDIR + "/x.sod", "x");
54
55 // Open the file
56 a = h5open(TMPDIR + "/x.sod", "r");
57
58 // Test
59 h5isRef(a)
60
61 // Test against the references in the dataset named 'x'
62 y = a.root.x.data;
63 h5isRef(y)
64
65 // Get the reference values
66 y(1).data, y(2).data
67
68 // We close all
69 h5close(a)
70     ]]></programlisting>
71     </refsection>
72     <refsection role="see also">
73         <title>See also</title>
74         <simplelist type="inline">
75             <member>
76                 <link linkend="h5isFile">h5isFile</link>
77             </member>
78         </simplelist>
79         <simplelist type="inline">
80             <member>
81                 <link linkend="h5isGroup">h5isGroup</link>
82             </member>
83         </simplelist>
84         <simplelist type="inline">
85             <member>
86                 <link linkend="h5isSet">h5isSet</link>
87             </member>
88         </simplelist>
89         <simplelist type="inline">
90             <member>
91                 <link linkend="h5isAttr">h5isAttr</link>
92             </member>
93         </simplelist>
94         <simplelist type="inline">
95             <member>
96                 <link linkend="h5isSpace">h5isSpace</link>
97             </member>
98         </simplelist>
99         <simplelist type="inline">
100             <member>
101                 <link linkend="h5isType">h5isType</link>
102             </member>
103         </simplelist>
104         <simplelist type="inline">
105             <member>
106                 <link linkend="h5isArray">h5isCompound</link>
107             </member>
108         </simplelist>
109         <simplelist type="inline">
110             <member>
111                 <link linkend="h5isArray">h5isArray</link>
112             </member>
113         </simplelist>
114         <simplelist type="inline">
115             <member>
116                 <link linkend="h5isVlen">h5isVlen</link>
117             </member>
118         </simplelist>
119     </refsection>
120     <refsection>
121         <title>History</title>
122         <revhistory>
123             <revision>
124                 <revnumber>5.5.0</revnumber>
125                 <revremark>HDF5 module introduced.</revremark>
126             </revision>
127         </revhistory>
128     </refsection>
129 </refentry>