---

aflibChainNode Class Reference

Data class used by aflibChain base class. More...

#include <aflibChainNode.h>

List of all members.

Public Methods
	aflibChainNode (aflibAudio &audio_item)
	This is the only constructor available and requires node it represents.
	~aflibChainNode ()
	Destructor.
int	addParent (aflibAudio &parent_item)
	Adds a parent audio object to the list of parents for this node. More...
void	removeParent (int parent_id)
	Remove a parent from this node.
void	replaceParent (aflibAudio &parent_item, int parent_id)
	Replaces an existing parent with a new parent. More...
aflibAudio&	getAudioItem ()
map<int, aflibAudio *, less< int> >&	getParents ()
bool	getNodeProcessed () const
	Returns if this node has been processed. More...
void	setNodeProcessed (bool node)

---

Detailed Description

Data class used by aflibChain base class.

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 aflibChain class only.

---

Constructor & Destructor Documentation

aflibChainNode::aflibChainNode ( aflibAudio & audio_item )

This is the only constructor available and requires node it represents.

aflibChainNode::~aflibChainNode ( )

Destructor.

---

Member Function Documentation

int aflibChainNode::addParent ( aflibAudio & parent_item )

Adds a parent audio object to the list of parents for this node. 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.

aflibAudio & aflibChainNode::getAudioItem ( )

\breify Returns the audio object that this node represents.

bool aflibChainNode::getNodeProcessed ( ) const

Returns if this node has been processed. 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.

map< int, aflibAudio *, less< int > > & aflibChainNode::getParents ( )

\breify Returns the parents of this audio object. 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.

void aflibChainNode::removeParent ( int parent_id )

Remove a parent from this node.

void aflibChainNode::replaceParent ( aflibAudio & parent_item, int parent_id )

Replaces an existing parent with a new parent. This will replace an existing parent with a new parent keeping the ID number the same for this node.

void aflibChainNode::setNodeProcessed ( bool node )

\breify Sets the processed state of this node. 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.

---

The documentation for this class was generated from the following files:

• aflibChainNode.h
• aflibChainNode.cc

---