yap-6.3/packages/gecode/dev/extractor/xml/classGecode_1_1LocalHandle.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
  <compounddef id="classGecode_1_1LocalHandle" kind="class" prot="public">
    <compoundname>Gecode::LocalHandle</compoundname>
    <includes refid="core_8hpp" local="no">core.hpp</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classGecode_1_1LocalHandle_1a169fa05afb36b855179c20297b9889a5" prot="private" static="no" mutable="no">
        <type><ref refid="classGecode_1_1LocalObject" kindref="compound">LocalObject</ref> *</type>
        <definition>LocalObject* Gecode::LocalHandle::o</definition>
        <argsstring></argsstring>
        <name>o</name>
        <briefdescription>
<para>The local object. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/core.hpp" line="1213" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="1213" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-func">
      <memberdef kind="function" id="classGecode_1_1LocalHandle_1a17c49543d1b2ed5238e5a0a9fb388b02" prot="protected" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::LocalHandle::LocalHandle</definition>
        <argsstring>(void)</argsstring>
        <name>LocalHandle</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Create local handle pointing to NULL object. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/core.hpp" line="1216" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3065" bodyend="3065"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1LocalHandle_1a7dcca08544e7f71198f0c9dca8b32f6e" prot="protected" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::LocalHandle::LocalHandle</definition>
        <argsstring>(LocalObject *lo)</argsstring>
        <name>LocalHandle</name>
        <param>
          <type><ref refid="classGecode_1_1LocalObject" kindref="compound">LocalObject</ref> *</type>
          <declname>lo</declname>
        </param>
        <briefdescription>
<para>Create local handle that points to local object <emphasis>lo</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/core.hpp" line="1218" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3067" bodyend="3067"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1LocalHandle_1a5cc34a7fd49dfc28293f4060b4773e32" prot="protected" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::LocalHandle::LocalHandle</definition>
        <argsstring>(const LocalHandle &amp;lh)</argsstring>
        <name>LocalHandle</name>
        <param>
          <type>const <ref refid="classGecode_1_1LocalHandle" kindref="compound">LocalHandle</ref> &amp;</type>
          <declname>lh</declname>
        </param>
        <briefdescription>
<para>Copy constructor. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/core.hpp" line="1220" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3069" bodyend="3069"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1LocalHandle_1a6615ca14a2b654c1fed31303f5a81911" prot="protected" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classGecode_1_1LocalObject" kindref="compound">LocalObject</ref> *</type>
        <definition>forceinline LocalObject * Gecode::LocalHandle::object</definition>
        <argsstring>(void) const </argsstring>
        <name>object</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Access to the local object. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/core.hpp" line="1230" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3078" bodyend="3078"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1LocalHandle_1aa89e59414e03a785094ccef138f91729" prot="protected" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>forceinline void Gecode::LocalHandle::object</definition>
        <argsstring>(LocalObject *n)</argsstring>
        <name>object</name>
        <param>
          <type><ref refid="classGecode_1_1LocalObject" kindref="compound">LocalObject</ref> *</type>
          <declname>n</declname>
        </param>
        <briefdescription>
<para>Modify local object. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/core.hpp" line="1232" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3080" bodyend="3080"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classGecode_1_1LocalHandle_1afe5de3896dc56795bd9490e0905710ca" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classGecode_1_1LocalHandle" kindref="compound">LocalHandle</ref> &amp;</type>
        <definition>forceinline LocalHandle &amp; Gecode::LocalHandle::operator=</definition>
        <argsstring>(const LocalHandle &amp;lh)</argsstring>
        <name>operator=</name>
        <param>
          <type>const <ref refid="classGecode_1_1LocalHandle" kindref="compound">LocalHandle</ref> &amp;</type>
          <declname>lh</declname>
        </param>
        <briefdescription>
<para>Assignment operator. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/core.hpp" line="1223" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3071" bodyend="3074"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1LocalHandle_1ad788203ccbe035b67cac4f221183e105" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>forceinline void Gecode::LocalHandle::update</definition>
        <argsstring>(Space &amp;home, bool share, LocalHandle &amp;lh)</argsstring>
        <name>update</name>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type>bool</type>
          <declname>share</declname>
        </param>
        <param>
          <type><ref refid="classGecode_1_1LocalHandle" kindref="compound">LocalHandle</ref> &amp;</type>
          <declname>lh</declname>
        </param>
        <briefdescription>
<para>Updating during cloning. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/core.hpp" line="1225" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3082" bodyend="3084"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1LocalHandle_1ab7e58ea477a8c31d6a43080c9b027103" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::LocalHandle::~LocalHandle</definition>
        <argsstring>(void)</argsstring>
        <name>~LocalHandle</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Destructor. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/core.hpp" line="1227" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3076" bodyend="3076"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Handles for local (space-shared) objects. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/usr/include/gecode/kernel/core.hpp" line="1210" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="1210" bodyend="1233"/>
    <listofallmembers>
      <member refid="classGecode_1_1LocalHandle_1a17c49543d1b2ed5238e5a0a9fb388b02" prot="protected" virt="non-virtual"><scope>Gecode::LocalHandle</scope><name>LocalHandle</name></member>
      <member refid="classGecode_1_1LocalHandle_1a7dcca08544e7f71198f0c9dca8b32f6e" prot="protected" virt="non-virtual"><scope>Gecode::LocalHandle</scope><name>LocalHandle</name></member>
      <member refid="classGecode_1_1LocalHandle_1a5cc34a7fd49dfc28293f4060b4773e32" prot="protected" virt="non-virtual"><scope>Gecode::LocalHandle</scope><name>LocalHandle</name></member>
      <member refid="classGecode_1_1LocalHandle_1a169fa05afb36b855179c20297b9889a5" prot="private" virt="non-virtual"><scope>Gecode::LocalHandle</scope><name>o</name></member>
      <member refid="classGecode_1_1LocalHandle_1a6615ca14a2b654c1fed31303f5a81911" prot="protected" virt="non-virtual"><scope>Gecode::LocalHandle</scope><name>object</name></member>
      <member refid="classGecode_1_1LocalHandle_1aa89e59414e03a785094ccef138f91729" prot="protected" virt="non-virtual"><scope>Gecode::LocalHandle</scope><name>object</name></member>
      <member refid="classGecode_1_1LocalHandle_1afe5de3896dc56795bd9490e0905710ca" prot="public" virt="non-virtual"><scope>Gecode::LocalHandle</scope><name>operator=</name></member>
      <member refid="classGecode_1_1LocalHandle_1ad788203ccbe035b67cac4f221183e105" prot="public" virt="non-virtual"><scope>Gecode::LocalHandle</scope><name>update</name></member>
      <member refid="classGecode_1_1LocalHandle_1ab7e58ea477a8c31d6a43080c9b027103" prot="public" virt="non-virtual"><scope>Gecode::LocalHandle</scope><name>~LocalHandle</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>