yap-6.3/packages/gecode/dev/extractor/xml/classGecode_1_1EngineBase.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_1EngineBase" kind="class" prot="public">
    <compoundname>Gecode::EngineBase</compoundname>
    <derivedcompoundref refid="classGecode_1_1BAB" prot="public" virt="non-virtual">Gecode::BAB&lt; T &gt;</derivedcompoundref>
    <derivedcompoundref refid="classGecode_1_1DFS" prot="public" virt="non-virtual">Gecode::DFS&lt; T &gt;</derivedcompoundref>
    <derivedcompoundref refid="classGecode_1_1RBS" prot="public" virt="non-virtual">Gecode::RBS&lt; E, T &gt;</derivedcompoundref>
    <includes refid="search_8hh" local="no">search.hh</includes>
      <sectiondef kind="friend">
      <memberdef kind="friend" id="classGecode_1_1EngineBase_1a33d16faae67d72b1ba40db1e427890a9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>template&lt; class &gt;</type>
            <declname>class</declname>
            <defname>class</defname>
          </param>
          <param>
            <type>class</type>
          </param>
        </templateparamlist>
        <type>friend class</type>
        <definition>friend class ::Gecode::RBS</definition>
        <argsstring></argsstring>
        <name>::Gecode::RBS</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/search.hh" line="464" column="1" bodyfile="/usr/include/gecode/search.hh" bodystart="464" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classGecode_1_1EngineBase_1aad42a01412e5ed2623cfeb52c4b09e82" prot="protected" static="no" mutable="no">
        <type><ref refid="classGecode_1_1Search_1_1Engine" kindref="compound">Search::Engine</ref> *</type>
        <definition>Search::Engine* Gecode::EngineBase::e</definition>
        <argsstring></argsstring>
        <name>e</name>
        <briefdescription>
<para>The actual search engine. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/search.hh" line="467" column="1" bodyfile="/usr/include/gecode/search.hh" bodystart="467" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-func">
      <memberdef kind="function" id="classGecode_1_1EngineBase_1a81e38a477373df7e3d2c9afa26443614" prot="protected" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::EngineBase::~EngineBase</definition>
        <argsstring>(void)</argsstring>
        <name>~EngineBase</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Destructor. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/search.hh" line="469" column="1" bodyfile="/usr/include/gecode/search/engine-base.hpp" bodystart="48" bodyend="50"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1EngineBase_1af4d765d70c5acafc444eaae03bcc658f" prot="protected" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::EngineBase::EngineBase</definition>
        <argsstring>(Search::Engine *e=NULL)</argsstring>
        <name>EngineBase</name>
        <param>
          <type><ref refid="classGecode_1_1Search_1_1Engine" kindref="compound">Search::Engine</ref> *</type>
          <declname>e</declname>
          <defval>NULL</defval>
        </param>
        <briefdescription>
<para>Constructor. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/search.hh" line="471" column="1" bodyfile="/usr/include/gecode/search/engine-base.hpp" bodystart="45" bodyend="46"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Base-class for search engines. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="1977">
        <label>Gecode::BAB&lt; T &gt;</label>
        <link refid="classGecode_1_1BAB"/>
        <childnode refid="1976" relation="public-inheritance">
        </childnode>
      </node>
      <node id="1978">
        <label>Gecode::DFS&lt; T &gt;</label>
        <link refid="classGecode_1_1DFS"/>
        <childnode refid="1976" relation="public-inheritance">
        </childnode>
      </node>
      <node id="1976">
        <label>Gecode::EngineBase</label>
        <link refid="classGecode_1_1EngineBase"/>
      </node>
      <node id="1979">
        <label>Gecode::RBS&lt; E, T &gt;</label>
        <link refid="classGecode_1_1RBS"/>
        <childnode refid="1976" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="1980">
        <label>Gecode::EngineBase</label>
        <link refid="classGecode_1_1EngineBase"/>
        <childnode refid="1981" relation="usage">
          <edgelabel>e</edgelabel>
        </childnode>
      </node>
      <node id="1981">
        <label>Gecode::Search::Engine</label>
        <link refid="classGecode_1_1Search_1_1Engine"/>
      </node>
    </collaborationgraph>
    <location file="/usr/include/gecode/search.hh" line="463" column="1" bodyfile="/usr/include/gecode/search.hh" bodystart="463" bodyend="472"/>
    <listofallmembers>
      <member refid="classGecode_1_1EngineBase_1a33d16faae67d72b1ba40db1e427890a9" prot="public" virt="non-virtual"><scope>Gecode::EngineBase</scope><name>::Gecode::RBS</name></member>
      <member refid="classGecode_1_1EngineBase_1aad42a01412e5ed2623cfeb52c4b09e82" prot="protected" virt="non-virtual"><scope>Gecode::EngineBase</scope><name>e</name></member>
      <member refid="classGecode_1_1EngineBase_1af4d765d70c5acafc444eaae03bcc658f" prot="protected" virt="non-virtual"><scope>Gecode::EngineBase</scope><name>EngineBase</name></member>
      <member refid="classGecode_1_1EngineBase_1a81e38a477373df7e3d2c9afa26443614" prot="protected" virt="non-virtual"><scope>Gecode::EngineBase</scope><name>~EngineBase</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>