[doc] HDF5: New help subsection h5is* (10 items)
[scilab.git] / scilab / modules / hdf5 / help / en_US / h5is_checks / h5isCompound.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="h5isCompound" xml:lang="en">
17     <refnamediv>
18         <refname>h5isCompound</refname>
19         <refpurpose>Check if the HDF5 object is a compound object</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>
24             b = h5isCompound(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 compound 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 = (1:10) + %i*(20:29);
53 save(TMPDIR + "/x.sod", "x");
54
55 // Open the file
56 a = h5open(TMPDIR + "/x.sod", "r");
57
58 // Test
59 h5isCompound(a)
60
61 // Test against root.x.data
62 h5isCompound(a.root.x.data)
63
64 // We close all
65 h5close(a)
66     ]]></programlisting>
67     </refsection>
68     <refsection role="see also">
69         <title>See also</title>
70         <simplelist type="inline">
71             <member>
72                 <link linkend="h5isFile">h5isFile</link>
73             </member>
74         </simplelist>
75         <simplelist type="inline">
76             <member>
77                 <link linkend="h5isSet">h5isSet</link>
78             </member>
79         </simplelist>
80         <simplelist type="inline">
81             <member>
82                 <link linkend="h5isAttr">h5isAttr</link>
83             </member>
84         </simplelist>
85         <simplelist type="inline">
86             <member>
87                 <link linkend="h5isSpace">h5isSpace</link>
88             </member>
89         </simplelist>
90         <simplelist type="inline">
91             <member>
92                 <link linkend="h5isType">h5isType</link>
93             </member>
94         </simplelist>
95         <simplelist type="inline">
96             <member>
97                 <link linkend="h5isRef">h5isRef</link>
98             </member>
99         </simplelist>
100         <simplelist type="inline">
101             <member>
102                 <link linkend="h5isArray">h5isArray</link>
103             </member>
104         </simplelist>
105         <simplelist type="inline">
106             <member>
107                 <link linkend="h5isVlen">h5isVlen</link>
108             </member>
109         </simplelist>
110     </refsection>
111     <refsection>
112         <title>History</title>
113         <revhistory>
114             <revision>
115                 <revnumber>5.5.0</revnumber>
116                 <revremark>HDF5 module introduced.</revremark>
117             </revision>
118         </revhistory>
119     </refsection>
120 </refentry>