csl::Port Class Reference

#include <CSL_Core.h>

List of all members.

Public Member Functions
	Port ()
	Constructors: default is a float = 0.
	Port (UnitGenerator *ug)
	Given a UGen, use it as the input.
	Port (float value)
	given a float, hold it as the static value
virtual	~Port ()
	Destructor.
void	checkBuffer () throw (LogicError)
	check the port's buffer and allocate it if needed
float	nextValue ()
	answer the next value (dynamic or constant)
void	nextFrame (SampleBuffer where)
bool	isReady ()
void	resetPtr ()
	reset the buffer pointer without re-pulling the input
virtual bool	isActive ()
	answer whether I'm active
void	dump ()
	pretty-print the receiver
bool	isFixed ()
Public Attributes
UnitGenerator *	mUGen
	my unit generator (pointer)
Buffer *	mBuffer
	the buffer used to hold my output
float	mValue
	my value (in case I'm fixed [mUGen == NULL])
float *	mValuePtr
	my value's address (const or buffer pointer)
unsigned	mPtrIncrement
	the inter-sample ptr increment (0 for const, 1 for dynamic)
unsigned	mValueIndex
	my index (into the UGen's buffer)

---

Detailed Description

Port -- used to represent constant, control-rate or signal inputs and outputs in named maps; holds a UnitGenerator and its buffer, OR a single floating-point value (in which case the UGen pointer is set to NULL and mPtrIncrement = 0). The nextValue() message is used to get the dynamic or static value.

---

Constructor & Destructor Documentation

Port::Port

(

)

Constructors: default is a float = 0.

Port::Port

(

UnitGenerator *

ug

)

Given a UGen, use it as the input.

References csl::Buffer::allocateBuffers(), mBuffer, csl::Buffer::monoBuffer(), and mValuePtr.

Port::Port

(

float

value

)

given a float, hold it as the static value

Port::~Port

(

)

[virtual]

Destructor.

---

Member Function Documentation

void Port::checkBuffer

(

)

throw (LogicError)

check the port's buffer and allocate it if needed

References csl::Buffer::allocateBuffers(), csl::CGestalt::blockSize(), csl::Buffer::freeBuffers(), mBuffer, csl::Buffer::mNumChannels, csl::Buffer::mNumFrames, mUGen, csl::UnitGenerator::numChannels(), and csl::Buffer::setSize().

sample csl::Port::nextValue

(

)

[inline]

answer the next value (dynamic or constant)

References mPtrIncrement, and mValuePtr.

Referenced by csl::NtoMPanner::nextBuffer(), and csl::Panner::nextBuffer().

void csl::Port::nextFrame

(

SampleBuffer

where

)

[inline]

References mBuffer, csl::Buffer::mBuffers, csl::Buffer::mNumChannels, and mValueIndex.

bool csl::Port::isReady

(

)

[inline]

References mValuePtr.

void Port::resetPtr

(

)

reset the buffer pointer without re-pulling the input

References mBuffer, csl::Buffer::monoBuffer(), mPtrIncrement, and mValuePtr.

bool Port::isActive

(

)

[virtual]

answer whether I'm active

References csl::UnitGenerator::isActive(), and mUGen.

void Port::dump

(

void

)

pretty-print the receiver

References csl::UnitGenerator::dump(), csl::logMsg(), mPtrIncrement, mUGen, and mValue.

Referenced by csl::BinaryOp::dump().

bool csl::Port::isFixed

(

)

[inline]

References mPtrIncrement.

---

Member Data Documentation

UnitGenerator* csl::Port::mUGen

my unit generator (pointer)

Referenced by checkBuffer(), dump(), csl::AmbisonicEncoder::input(), isActive(), csl::SpatialSource::nextBuffer(), csl::DistanceSimulator::nextBuffer(), csl::AmbisonicEncoder::setInput(), csl::AmbisonicDecoder::~AmbisonicDecoder(), and csl::AmbisonicRotator::~AmbisonicRotator().

Buffer* csl::Port::mBuffer

the buffer used to hold my output

Referenced by checkBuffer(), csl::RtpSender::nextBuffer(), csl::LPCAnalyzer::nextBuffer(), csl::DelayLine::nextBuffer(), csl::InOut::nextBuffer(), nextFrame(), Port(), csl::Effect::pullInput(), and resetPtr().

float csl::Port::mValue

my value (in case I'm fixed [mUGen == NULL])

Referenced by csl::Controllable::addInput(), and dump().

float* csl::Port::mValuePtr

my value's address (const or buffer pointer)

Referenced by isReady(), nextValue(), Port(), and resetPtr().

unsigned csl::Port::mPtrIncrement

the inter-sample ptr increment (0 for const, 1 for dynamic)

Referenced by dump(), isFixed(), nextValue(), and resetPtr().

unsigned csl::Port::mValueIndex

my index (into the UGen's buffer)

Referenced by nextFrame().

---

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

• CSL/Kernel/CSL_Core.h
• CSL/Kernel/CSL_Core.cpp