📄 classaflibchain.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>aflibChain class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.15 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>aflibChain Class Reference</h1>Base class that implements chaining for audio objects. <a href="#_details">More...</a><p><code>#include <<a class="el" href="aflibChain_8h-source.html">aflibChain.h</a>></code><p><p>Inheritance diagram for aflibChain:<p><center><img src="classaflibChain.png" usemap="#aflibChain_map" border="0"></center><map name="aflibChain_map"><area href="classaflibAudio.html" alt="aflibAudio" shape="rect" coords="0,56,154,80"><area href="classaflibAudioBWFilter.html" alt="aflibAudioBWFilter" shape="rect" coords="164,112,318,136"><area href="classaflibAudioConstantSrc.html" alt="aflibAudioConstantSrc" shape="rect" coords="164,168,318,192"><area href="classaflibAudioEdit.html" alt="aflibAudioEdit" shape="rect" coords="164,224,318,248"><area href="classaflibAudioFile.html" alt="aflibAudioFile" shape="rect" coords="164,280,318,304"><area href="classaflibAudioMemoryInput.html" alt="aflibAudioMemoryInput" shape="rect" coords="164,336,318,360"><area href="classaflibAudioMixer.html" alt="aflibAudioMixer" shape="rect" coords="164,392,318,416"><area href="classaflibAudioRecorder.html" alt="aflibAudioRecorder" shape="rect" coords="164,448,318,472"><area href="classaflibAudioSampleRateCvt.html" alt="aflibAudioSampleRateCvt" shape="rect" coords="164,504,318,528"><area href="classaflibAudioSpectrum.html" alt="aflibAudioSpectrum" shape="rect" coords="164,560,318,584"></map><a href="classaflibChain-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0><tr><td colspan=2><br><h2>Public Methods</h2></td></tr><tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classaflibChain.html#a0">~aflibChain</a> ()</td></tr><tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>const map< int, <a class="el" href="classaflibAudio.html">aflibAudio</a> *,<br> less< int > > & </td><td valign=bottom><a class="el" href="classaflibChain.html#a1">getParents</a> () const</td></tr><tr><td> </td><td><font size=-1><em>Returns parent objects and IDs for this audio object.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classaflibChain.html#a2">addParent</a> (<a class="el" href="classaflibAudio.html">aflibAudio</a> &parent)</td></tr><tr><td> </td><td><font size=-1><em>Adds a parent to an object in a chain.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classaflibChain.html#a3">removeParent</a> (int parent_id)</td></tr><tr><td> </td><td><font size=-1><em>Removes a parent from an object in a chain referenced by ID.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classaflibChain.html#a4">removeParent</a> (<a class="el" href="classaflibAudio.html">aflibAudio</a> &parent)</td></tr><tr><td> </td><td><font size=-1><em>Removes a parent from an object in a chain referenced by object.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classaflibChain.html#a5">getNodeProcessed</a> () const</td></tr><tr><td> </td><td><font size=-1><em>Notifies if this object has been fully processed in the chain.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classaflibChain.html#a6">setNodeProcessed</a> (bool node)</td></tr><tr><td> </td><td><font size=-1><em>Sets the processed state for this object in the chain.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classaflibChain.html#a7">dumpChain</a> (bool check_env=TRUE)</td></tr><tr><td> </td><td><font size=-1><em>Dumps the contents of audio chain.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr><tr><td colspan=2><br><h2>Protected Methods</h2></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classaflibChain.html#b0">aflibChain</a> ()</td></tr><tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classaflibChain.html#b1">aflibChain</a> (<a class="el" href="classaflibAudio.html">aflibAudio</a> &parent)</td></tr><tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classaflibChain.html#b2">replaceParent</a> (<a class="el" href="classaflibAudio.html">aflibAudio</a> &old_p, <a class="el" href="classaflibAudio.html">aflibAudio</a> &new_p)</td></tr><tr><td> </td><td><font size=-1><em>Replaces a parent with another parent keeping the same ID.</em> <a href="#b2">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classaflibChain.html#b3">parentWasDestroyed</a> (int parent_id)</td></tr><tr><td> </td><td><font size=-1><em>Callback to notify derived class when parent was destroyed.</em> <a href="#b3">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classaflibChain.html#b4">parentWasAdded</a> (int parent_id)</td></tr><tr><td> </td><td><font size=-1><em>Callback to notify derived class when parent was added.</em> <a href="#b4">More...</a><em></em></font><br><br></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>Base class that implements chaining for audio objects.<p>This is the base class that provides the mechanism to chain audio objects together. It maintains several static lists that contain all of the chain information for this application. Derived class can override two functions that will inform them when a parent has been added or destroyed. Also provided in this base class are member functions to add and remove parents from an audio object. The ID for a parent that is added by using the constructor is 1. All others added with the addParent call will be returned with this call.<p>This class provides a default contructor for the start of a chain and a constructor that takes an <a class="el" href="classaflibAudio.html">aflibAudio</a> object as the parent of this object. This class is also designed to be a base class for <a class="el" href="classaflibAudio.html">aflibAudio</a>. This is so that all <a class="el" href="classaflibAudio.html">aflibAudio</a> derived classes will inherit its functionality. <p><hr><h2>Constructor & Destructor Documentation</h2><a name="a0" doxytag="aflibChain::~aflibChain"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> aflibChain::~aflibChain </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Destructor.<p> </td> </tr></table><a name="b0" doxytag="aflibChain::aflibChain"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> aflibChain::aflibChain </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [protected]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Constructor.<p>This constructor is for derived classes that have no parent audio object. </td> </tr></table><a name="b1" doxytag="aflibChain::aflibChain"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> aflibChain::aflibChain </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classaflibAudio.html">aflibAudio</a> & </td> <td class="mdname1" valign="top" nowrap> <em>parent</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [protected]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Constructor.<p>This constructor is for derived classes that have a parent audio object. </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="a2" doxytag="aflibChain::addParent"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int aflibChain::addParent </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classaflibAudio.html">aflibAudio</a> & </td> <td class="mdname1" valign="top" nowrap> <em>parent</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Adds a parent to an object in a chain.<p>If an object wishes to add another item as a parent we will let them. Some objects need more than one input. This provides for it. An ID will be be returned to the user. This is how users should reference this input. If the parent is already attached to the child and in te list then its existing ID will be returned. </td> </tr></table><a name="a7" doxytag="aflibChain::dumpChain"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void aflibChain::dumpChain </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">bool </td> <td class="mdname1" valign="top" nowrap> <em>check_env</em> = TRUE </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Dumps the contents of audio chain.<p>This function will dump the contents of the current chain. If TRUE or no input parameter then the env AFLIB_DUMP_CHAIN will be checked to see if it is set. If it is not then no output. If FALSE is passed in then the chain will be dumped to stdout if the env is set or not. </td> </tr></table><a name="a5" doxytag="aflibChain::getNodeProcessed"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool aflibChain::getNodeProcessed </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -