aflibchain.3

一个共享源码的音频库5(doc 文档)

.TH "aflibChain" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibChain \- Base class that implements chaining for audio objects. 
.SH SYNOPSIS
.br
.PP
\fC#include <aflibChain.h>\fP
.PP
Inherited by \fBaflibAudio\fP.
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "virtual \fB~aflibChain\fP ()"
.br
.RI "\fIDestructor.\fP"
.ti -1c
.RI "const map< int, \fBaflibAudio\fP *, less< int > > & \fBgetParents\fP () const"
.br
.RI "\fIReturns parent objects and IDs for this audio object.\fP"
.ti -1c
.RI "int \fBaddParent\fP (\fBaflibAudio\fP &parent)"
.br
.RI "\fIAdds a parent to an object in a chain.\fP"
.ti -1c
.RI "void \fBremoveParent\fP (int parent_id)"
.br
.RI "\fIRemoves a parent from an object in a chain referenced by ID.\fP"
.ti -1c
.RI "void \fBremoveParent\fP (\fBaflibAudio\fP &parent)"
.br
.RI "\fIRemoves a parent from an object in a chain referenced by object.\fP"
.ti -1c
.RI "bool \fBgetNodeProcessed\fP () const"
.br
.RI "\fINotifies if this object has been fully processed in the chain.\fP"
.ti -1c
.RI "void \fBsetNodeProcessed\fP (bool node)"
.br
.RI "\fISets the processed state for this object in the chain.\fP"
.ti -1c
.RI "void \fBdumpChain\fP (bool check_env=TRUE)"
.br
.RI "\fIDumps the contents of audio chain.\fP"
.in -1c
.SS "Protected Methods"

.in +1c
.ti -1c
.RI "\fBaflibChain\fP ()"
.br
.RI "\fIConstructor.\fP"
.ti -1c
.RI "\fBaflibChain\fP (\fBaflibAudio\fP &parent)"
.br
.RI "\fIConstructor.\fP"
.ti -1c
.RI "void \fBreplaceParent\fP (\fBaflibAudio\fP &old_p, \fBaflibAudio\fP &new_p)"
.br
.RI "\fIReplaces a parent with another parent keeping the same ID.\fP"
.ti -1c
.RI "virtual void \fBparentWasDestroyed\fP (int parent_id)"
.br
.RI "\fICallback to notify derived class when parent was destroyed.\fP"
.ti -1c
.RI "virtual void \fBparentWasAdded\fP (int parent_id)"
.br
.RI "\fICallback to notify derived class when parent was added.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Base class that implements chaining for audio objects.
.PP
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.
.PP
This class provides a default contructor for the start of a chain and a constructor that takes an \fBaflibAudio\fP object as the parent of this object. This class is also designed to be a base class for \fBaflibAudio\fP. This is so that all \fBaflibAudio\fP derived classes will inherit its functionality. 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibChain::~aflibChain ()\fC [virtual]\fP"
.PP
Destructor.
.PP
.SS "aflibChain::aflibChain ()\fC [protected]\fP"
.PP
Constructor.
.PP
This constructor is for derived classes that have no parent audio object. 
.SS "aflibChain::aflibChain (\fBaflibAudio\fP & parent)\fC [protected]\fP"
.PP
Constructor.
.PP
This constructor is for derived classes that have a parent audio object. 
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "int aflibChain::addParent (\fBaflibAudio\fP & parent)"
.PP
Adds a parent to an object in a chain.
.PP
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. 
.SS "void aflibChain::dumpChain (bool check_env = TRUE)"
.PP
Dumps the contents of audio chain.
.PP
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. 
.SS "bool aflibChain::getNodeProcessed () const"
.PP
Notifies if this object has been fully processed in the chain.
.PP
This notifies the caller if the chain has been fully processed. This is useful so that the base classes can modify the chain if it needs to after it has been changed or modified and before any data it passed thru the chain. This is needed for things such as the sample rate converter class that can be inserted automattically if needed. If TRUE is returned then this node has not changed since it was processed last. If FALSE then this node has changed. 
.SS "const map< int, \fBaflibAudio\fP *, less< int > > & aflibChain::getParents () const"
.PP
Returns parent objects and IDs for this audio object.
.PP
This function will return the parents and IDs for this audio object. The order in the map will be in ID order. 
.SS "void aflibChain::parentWasAdded (int parent_id)\fC [protected, virtual]\fP"
.PP
Callback to notify derived class when parent was added.
.PP
This is a callback that derived classes override to get notified when a parent is added. It will not get called when a parent is set in the constructor. 
.PP
Reimplemented in \fBaflibAudioEdit\fP.
.SS "void aflibChain::parentWasDestroyed (int parent_id)\fC [protected, virtual]\fP"
.PP
Callback to notify derived class when parent was destroyed.
.PP
This is a callback that derived classes override to get notified when a parent was removed from an object 
.PP
Reimplemented in \fBaflibAudioEdit\fP.
.SS "void aflibChain::removeParent (\fBaflibAudio\fP & parent)"
.PP
Removes a parent from an object in a chain referenced by object.
.PP
This is a convience function that will perform the same function as the removeParent function that takes a parent id. It will simply lookup the parent id and call that function. 
.SS "void aflibChain::removeParent (int parent_id)"
.PP
Removes a parent from an object in a chain referenced by ID.
.PP
If an object wishes to remove a parent then we will let them. Some objects have more than one input and may want to remove one or more. NOTE: we are not talking about the node being deleted just the chain between this child and parent 
.SS "void aflibChain::replaceParent (\fBaflibAudio\fP & old_p, \fBaflibAudio\fP & new_p)\fC [protected]\fP"
.PP
Replaces a parent with another parent keeping the same ID.
.PP
This allows one to replace one parent with another parent while keeping the same ID. This is useful when inserting an object between two other objects but one does not want the audio object to consider this a new input. The \fBaflibAudio\fP base class uses this to insert a \fBaflibAudioSampleRateCvt\fP object in a chain without the child knowing it. 
.SS "void aflibChain::setNodeProcessed (bool node)"
.PP
Sets the processed state for this object in the chain.
.PP
This allows the caller to set the state of the node. The state is set in proper node class. It is initially set to FALSE in the node class. The caller should set it to TRUE when the chain has been fully setup and processed. Each node in the chain must be processed before data can be puled thru the chain. 

.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for Open Source Audio Library Project from the source code.