aflibchainnode.3

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

.TH "aflibChainNode" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibChainNode \- Data class used by \fBaflibChain\fP base class. 
.SH SYNOPSIS
.br
.PP
\fC#include <aflibChainNode.h>\fP
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBaflibChainNode\fP (\fBaflibAudio\fP &audio_item)"
.br
.RI "\fIThis is the only constructor available and requires node it represents.\fP"
.ti -1c
.RI "\fB~aflibChainNode\fP ()"
.br
.RI "\fIDestructor.\fP"
.ti -1c
.RI "int \fBaddParent\fP (\fBaflibAudio\fP &parent_item)"
.br
.RI "\fIAdds a parent audio object to the list of parents for this node.\fP"
.ti -1c
.RI "void \fBremoveParent\fP (int parent_id)"
.br
.RI "\fIRemove a parent from this node.\fP"
.ti -1c
.RI "void \fBreplaceParent\fP (\fBaflibAudio\fP &parent_item, int parent_id)"
.br
.RI "\fIReplaces an existing parent with a new parent.\fP"
.ti -1c
.RI "\fBaflibAudio\fP & \fBgetAudioItem\fP ()"
.br
.ti -1c
.RI "map< int, \fBaflibAudio\fP *, less< int > > & \fBgetParents\fP ()"
.br
.ti -1c
.RI "bool \fBgetNodeProcessed\fP () const"
.br
.RI "\fIReturns if this node has been processed.\fP"
.ti -1c
.RI "void \fBsetNodeProcessed\fP (bool node)"
.br
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Data class used by \fBaflibChain\fP base class.
.PP
This class contains all of the information about a node in the Chain. It keeps track of all the parents of a node in the chain. It also keeps track if a node has been processed in a chain. All nodes in a chain must be processed before data can flow thru the chain. This class is designed to be used by the \fBaflibChain\fP class only. 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibChainNode::aflibChainNode (\fBaflibAudio\fP & audio_item)"
.PP
This is the only constructor available and requires node it represents.
.PP
.SS "aflibChainNode::~aflibChainNode ()"
.PP
Destructor.
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "int aflibChainNode::addParent (\fBaflibAudio\fP & parent_item)"
.PP
Adds a parent audio object to the list of parents for this node.
.PP
Add a parent to this node . If the parent already exists then its ID will be returned. If it is not found then it will be added to the parent list and a unique ID returned. 
.SS "\fBaflibAudio\fP & aflibChainNode::getAudioItem ()"
.PP
\\breify Returns the audio object that this node represents. 
.SS "bool aflibChainNode::getNodeProcessed () const"
.PP
Returns if this node has been processed.
.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 "map< int, \fBaflibAudio\fP *, less< int > > & aflibChainNode::getParents ()"
.PP
\\breify Returns the parents of this audio object.
.PP
This returns the parents for this audio object. It will return them in a map so that the caller will have the IDs and objects. They will be in ID assending order. 
.SS "void aflibChainNode::removeParent (int parent_id)"
.PP
Remove a parent from this node.
.PP
.SS "void aflibChainNode::replaceParent (\fBaflibAudio\fP & parent_item, int parent_id)"
.PP
Replaces an existing parent with a new parent.
.PP
This will replace an existing parent with a new parent keeping the ID number the same for this node. 
.SS "void aflibChainNode::setNodeProcessed (bool node)"
.PP
\\breify Sets the processed state of this node.
.PP
This allows the caller to set the state of the node. The state is set to FALSE internally in this class when the state is changed. The caller should set it to TRUE when the chain has been fully setup and processed. 

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