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

<!--#set var="isip_page_title" value="AlgorithmUndefined" -->
<?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/algo/AlgorithmUndefined/AlgorithmUndefined.h">AlgorithmUndefined</a>: public <a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmBase/AlgorithmBase.h">AlgorithmBase</a></b>

<br><br>

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

<blockquote>
<pre>
const AlgorithmUndefined Algorithm::NO_ALGORITHM;
</pre>
</blockquote>

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

<blockquote>
<pre>
if (virtual_alg_d != (AlgorithmBase*)&NO_ALGORITHM) {
  delete virtual_alg_d;
}
</pre>
</blockquote>

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

This class is not invoked directly. It is only used to
represent the case where an

<a href="../Algorithm/index.html">Algorithm</a>

object has been instantiated, but a specific algorithm has not
been selected.

<br><br>

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

<ul>
  <li> <a href="../AlgorithmBase/index.html">AlgorithmBase</a>
  <li> <a href="../../mmedia/AlgorithmData/index.html">AlgorithmData</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/algo/AlgorithmUndefined/algu_00.cc&constant=CLASS_NAME">static const String CLASS_NAME = L"AlgorithmUndefined";</a></pre>
</ul>
       
<a name="error">       
<b>error codes:</b>
<br><br>

<ul>
  <li> none
</ul>

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

<ul>
  <li> none
</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/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=name">static const SysString& name();</a></pre>
       
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=diagnose">static boolean diagnose(const unichar* msg);</a></pre>
       
  <li> debug methods: setDebug method is inherited from the base class

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=debug">boolean debug(const unichar* msg) const;</a></pre>

  <li> destructor/constructor(s)

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

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

  <li> assign methods

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

  <li> i/o methods

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=sofSize">long sofSize() const;</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=read">boolean read(Sof& sof, long tag, const String& name);</a></pre>
        <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=write">boolean write(Sof& sof, long tag, const String& name) const;</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=readData">boolean readData(Sof& sof, const String& pname, long size, boolean param, boolean nested);</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=writeData">boolean writeData(Sof& sof, const String& pname) const;</a></pre>

  <li> equality methods

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=eq&instance=0">boolean eq(const AlgorithmUndefined& arg_a) const;</a></pre>
    
  <li> memory management methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=clear">boolean clear();</a></pre>
</ul>

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

<ul>
  <li> interface contract methods

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=assign&instance=1">boolean assign(const AlgorithmBase& arg);</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=eq&instance=1">boolean eq(const AlgorithmBase& arg);</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=className">const String& className() const;</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=init">boolean init();</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=apply">boolean apply(Vector&lt;AlgorithmData&gt;& output, const Vector&lt; CircularBuffer&lt;AlgorithmData&gt; &gt;& input);</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=getLeadingPad">long getLeadingPad() const;</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=getTrailingPad">long getTrailingPad() const;</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/algo/AlgorithmUndefined/AlgorithmUndefined.h&method=setParser">boolean setParser(SofParser* parser);</a></pre>
</ul>

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

<ul>       
  <li> none
</ul>

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

<ul>
  <li> This class is mainly used to intialize the Algorithm class:
<pre>
const AlgorithmUndefined Algorithm::NO_ALGORITHM;

if (virtual_alg_d != (AlgorithmBase*)&NO_ALGORITHM) {
  delete virtual_alg_d;
}
</pre>
</ul>
       
<a name="notes">
<b>notes:</b>

<ul>
  <li> This class should not be used for anything other than
       the definition shown above.
</ul>

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