<?php $isip_window_title = "ISIP Homepage"; ?>
<?php include("/data/isip/www/templates/documentation/header/header.html"); ?>

<!--#set var="isip_page_title" value="" -->
<?php include("/data/isip/www/templates/documentation/body/index_class.html"); ?>
<?php include("/data/isip/www/templates/documentation/body/bar.html"); ?>

<a name="name">
<b>

name:
<a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h">MachineDatabase</a>

</b>
<br><br>

<a name="synopsis">
<b>synopsis:</b>
<br><br>

<blockquote>
<pre>

g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_mmedia.a

#include &lt;MachineDatabase.h&gt;

boolean isEmpty();
String& getDataBaseName();
boolean setDataBaseName(String& arg);
Vector&lt;Machine&gt;& getDataBase();
boolean setDataBase(Vector&lt;Machine&gt;& arg);
boolean get(String& node, Machine& machine);

</pre>
</blockquote>

<a name="quick_start">
<b>quick start:</b>
<br><br>

<blockquote>
<pre>

String tmp_str;
MachineDatabase mdb_00;

tmp_str.assign(L"XYZ");
mdb.setDataBaseName(tmp_str);


</pre>
</blockquote>

<a name="description">
<b>description:</b>
<br><br>

This class is used to represent a database of machines and their corresponding attributes.

<br><br>

<a name="dependencies">
<b>dependencies:</b>
<br><br>

<ul>
  <li> <a href="../../math/scalar/String/">String.h</a>
  <li> <a href="../Machine/">Machine.h</a>
</ul>

<a name="constants">
<b>public constants:</b>
<br><br>

<ul>
  <li> define the class name:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_00.cc&constant=CLASS_NAME">static const String CLASS_NAME = L"MachineDatabase";</a></pre>

  <li> define i/o related constants:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_00.cc&constant=DEF_PARAM">static const String DEF_PARAM;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_00.cc&constant=PARAM_NAME">static const String PARAM_NAME;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_00.cc&constant=PARAM_MACHINES">static const String PARAM_MACHINES;</a></pre>

</ul>

<a name="error">
<b>error codes:</b>
<br><br>

<ul>
  <li> error codes indicating general errors:

</ul>

<a name="protected">
<b>protected data:</b>
<br><br>

<ul>
  <li> declare define the database name:

       <pre>String name_d;</pre>

  <li> declare define the container object:

       <pre>Vector&lt;Machine&gt; database_d;</pre>

  <li> declare the debugging parameters:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_00.cc&static=debug_level_d">static Integral::DEBUG debug_level_d;</a></pre>

  <li> declare the memory manager:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_00.cc&static=mgr_d">static MemoryManager mgr_d;</a></pre>

</ul>

<a name="public">
<b>required public methods:</b>
<br><br>

<ul>
  <li> static methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=name&instance=0">static const String& name();</a></pre>

  <li> debug methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_01.cc&method=debug&instance=0">boolean debug(const unichar* msg) const;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=setDebug&instance=0">static boolean setDebug(Integral::DEBUG arg);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_02.cc&method=diagnose&instance=0">static boolean diagnose(Integral::DEBUG debug_level);</a></pre>
       
  <li> destructor/constructor(s):

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=destructor&instance=0">~MachineDatabase();</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_00.cc&method=default+constructor&instance=0">MachineDatabase();</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=copy+constructor&instance=0">MachineDatabase(const MachineDatabase& arg);</a></pre>

  <li> assign methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_05.cc&method=assign&instance=0">boolean assign(const MachineDatabase& arg);</a></pre>

  <li> operator= method:

       <pre>not present.</pre>

  <li> i/o methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=sofSize&instance=0">long sofSize() const;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=read&instance=0">boolean read(Sof& sof, long tag);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_03.cc&method=read&instance=0">boolean read(Sof& sof, long tag, const String& name);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=write&instance=0">boolean write(Sof& sof, long tag) const;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_04.cc&method=write&instance=0">boolean write(Sof& sof, long tag, const String& name) const;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_03.cc&method=readData&instance=0">boolean readData(Sof& sof, const String& pname = DEF_PARAM, long size = SofParser::FULL_OBJECT, boolean param = true, boolean nested = false);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_04.cc&method=writeData&instance=0">boolean writeData(Sof& sof, const String& pname =  DEF_PARAM) const;</a></pre>

  <li> equality methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_05.cc&method=eq&instance=0">boolean eq(const MachineDatabase& arg) const;</a></pre>

  <li> memory management methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=new&instance=0">static void* operator new(size_t arg);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=new\[\]&instance=0">static void* operator new[](size_t arg);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=delete&instance=0">static void operator delete(void* arg);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=delete\[\]&instance=0">static void operator delete[](void* arg);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=setGrowSize&instance=0">static boolean setGrowSize(long arg);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/madb_05.cc&method=clear&instance=0">boolean clear(Integral::CMODE cmode = Integral::DEF_CMODE);</a></pre>

</ul>

<a name="specific">
<b>class-specific public methods:</b>
<br><br>

<ul>
  <li> declare database property methods:
       
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=isEmpty&instance=0">boolean isEmpty();</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=get&instance=0">boolean get(String& node, Machine& machine);</a></pre>
       
  <li> declare database name methods:
       
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=getDataBaseName&instance=0">String& getDataBaseName();</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=setDataBaseName&instance=0">boolean setDataBaseName(String& arg);</a></pre>

  <li> declare database access methods:
       
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=getDataBase&instance=0">Vector&lt;Machine&gt;& getDataBase();</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/MachineDatabase/MachineDatabase.h&method=setDataBase&instance=0">boolean setDataBase(Vector&lt;Machine&gt;& arg);</a></pre>
       
</ul>

<a name="private">
<b>private methods:</b>
<br><br>

<ul>
  <li> declare private methods:

</ul>

<a name="examples">
<b>examples:</b>
<br><br>

<ul>

    <li> This <a href="/perl/ifc_document.pl?file=$isip/doc/examples/class/mmedia/mmedia_example_09/example.cc">example</a> shows how to use the MachineDatabase object.
	 
</ul>

<a name="notes">
<b>notes:</b>
<br><br>

<ul>
  <li> none.
</ul>

<!--#include virtual="/hse/ies/templates/documentation/footer/footer.html" -->
