<?xml version="1.0" encoding="utf-8"?>
<!--
* Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET
*
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
*
-->
<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">
    <refnamediv>
        <refname>h5isCompound</refname>
        <refpurpose>Check if the HDF5 object is a compound object</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>
            b = h5isCompound(obj)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>obj</term>
                <listitem>
                    <para>a H5Object</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>b</term>
                <listitem>
                    <para>a boolean</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>Check if an HDF5 object is a compound object.</para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
// Create a SOD file which an HDF5 one
x = (1:10) + %i*(20:29);
save(TMPDIR + "/x.sod", "x");

// Open the file
a = h5open(TMPDIR + "/x.sod", "r");

// Test
h5isCompound(a)

// Test against root.x.data
h5isCompound(a.root.x.data)

// We close all
h5close(a)
    ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="h5isFile">h5isFile</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5isSet">h5isSet</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5isAttr">h5isAttr</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5isSpace">h5isSpace</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5isType">h5isType</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5isRef">h5isRef</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5isArray">h5isArray</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5isVlen">h5isVlen</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>History</title>
        <revhistory>
            <revision>
                <revnumber>5.5.0</revnumber>
                <revremark>HDF5 module introduced.</revremark>
            </revision>
        </revhistory>
    </refsection>
</refentry>
