AudioProcessorGraph::Node Class Reference

Represents one of the nodes, or processors, in an AudioProcessorGraph. More...

#include <juce_AudioProcessorGraph.h>

Inheritance diagram for AudioProcessorGraph::Node:

Collaboration diagram for AudioProcessorGraph::Node:

Public Types
typedef ReferenceCountedObjectPtr< Node >	Ptr
	A convenient typedef for referring to a pointer to a node object. More...

Public Member Functions
void	decReferenceCount () noexcept
	Decreases the object's reference count. More...
bool	decReferenceCountWithoutDeleting () noexcept
	Decreases the object's reference count. More...
AudioProcessor *	getProcessor () const noexcept
	The actual processor object that this node represents. More...
int	getReferenceCount () const noexcept
	Returns the object's current reference count. More...
void	incReferenceCount () noexcept
	Increments the object's reference count. More...

Public Attributes
const uint32	nodeId
	The ID number assigned to this node. More...
NamedValueSet	properties
	A set of user-definable properties that are associated with this node. More...

Protected Member Functions
void	resetReferenceCount () noexcept
	Resets the reference count to zero without deleting the object. More...

Private Member Functions
	Node (uint32 nodeId, AudioProcessor *) noexcept
void	prepare (double newSampleRate, int newBlockSize, AudioProcessorGraph *, ProcessingPrecision)
void	setParentGraph (AudioProcessorGraph *) const
void	unprepare ()

Private Attributes
bool	isPrepared
const ScopedPointer< AudioProcessor >	processor

Friends
class	AudioProcessorGraph

Detailed Description

Represents one of the nodes, or processors, in an AudioProcessorGraph.

To create a node, call AudioProcessorGraph::addNode().

Member Typedef Documentation

Ptr

typedef ReferenceCountedObjectPtr<Node> AudioProcessorGraph::Node::Ptr

A convenient typedef for referring to a pointer to a node object.

Constructor & Destructor Documentation

Node()

AudioProcessorGraph::Node::Node ( uint32  nodeId, AudioProcessor *    )

privatenoexcept

Member Function Documentation

decReferenceCount()

void ReferenceCountedObject::decReferenceCount ( )

inlinenoexceptinherited

Decreases the object's reference count.

If the count gets to zero, the object will be deleted.

References jassert.

decReferenceCountWithoutDeleting()

bool ReferenceCountedObject::decReferenceCountWithoutDeleting ( )

inlinenoexceptinherited

Decreases the object's reference count.

If the count gets to zero, the object will not be deleted, but this method will return true, allowing the caller to take care of deletion.

References jassert.

getProcessor()

AudioProcessor* AudioProcessorGraph::Node::getProcessor ( ) const

inlinenoexcept

The actual processor object that this node represents.

getReferenceCount()

int ReferenceCountedObject::getReferenceCount ( ) const

inlinenoexceptinherited

Returns the object's current reference count.

incReferenceCount()

void ReferenceCountedObject::incReferenceCount ( )

inlinenoexceptinherited

Increments the object's reference count.

This is done automatically by the smart pointer, but is public just in case it's needed for nefarious purposes.

prepare()

void AudioProcessorGraph::Node::prepare ( double  newSampleRate, int  newBlockSize, AudioProcessorGraph *  , ProcessingPrecision    )

private

resetReferenceCount()

void ReferenceCountedObject::resetReferenceCount ( )

inlineprotectednoexceptinherited

Resets the reference count to zero without deleting the object.

You should probably never need to use this!

setParentGraph()

void AudioProcessorGraph::Node::setParentGraph ( AudioProcessorGraph *  ) const

private

unprepare()

void AudioProcessorGraph::Node::unprepare ( )

private

Friends And Related Function Documentation

AudioProcessorGraph

friend class AudioProcessorGraph

friend

Member Data Documentation

isPrepared

bool AudioProcessorGraph::Node::isPrepared

private

nodeId

const uint32 AudioProcessorGraph::Node::nodeId

The ID number assigned to this node.

This is assigned by the graph that owns it, and can't be changed.

processor

const ScopedPointer<AudioProcessor> AudioProcessorGraph::Node::processor

private

properties

NamedValueSet AudioProcessorGraph::Node::properties

A set of user-definable properties that are associated with this node.

This can be used to attach values to the node for whatever purpose seems useful. For example, you might store an x and y position if your application is displaying the nodes on-screen.

---

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

• juce_AudioProcessorGraph.h