#include <AudioFrame.h>

Inheritance diagram for alize::AudioFrame:

Collaboration diagram for alize::AudioFrame:

Public Member Functions
	AudioFrame (long v=0, bool isValid=false)
	AudioFrame (const AudioFrame &)
const AudioFrame &	operator= (const AudioFrame &)
bool	operator== (const AudioFrame &) const
bool	operator!= (const AudioFrame &) const
virtual	~AudioFrame ()
bool	isValid () const
void	setValidity (bool validity)
void	setData (long v)
long	getData () const
virtual String	getClassName () const
virtual String	toString () const
Static Public Member Functions
static AudioFrame &	create (long value=0, bool isValid=false)
Private Attributes
bool	_isValid
long	_value
Friends
class	TestAudioFrame

Detailed Description

...

Author:: Frederic Wils frederic.wils@lia.univ-avignon.fr

Version:: 1.0

Date:: 2003

Definition at line 78 of file AudioFrame.h.

Constructor & Destructor Documentation

AudioFrame::AudioFrame	(	long	v = `0`,
		bool	isValid = `false`
	)		`[explicit]`

Create an AudioFrame object with default values

Parameters:

v	= value to store
isValid	true = the frame is valid; false = the frame is not valid

Definition at line 65 of file AudioFrame.cpp.

Referenced by create().

AudioFrame::AudioFrame ( const AudioFrame & f )

Definition at line 75 of file AudioFrame.cpp.

AudioFrame::~AudioFrame ( ) [virtual]

Definition at line 112 of file AudioFrame.cpp.

Member Function Documentation

AudioFrame & AudioFrame::create	(	long	value = `0`,
		bool	isValid = `false`
	)		`[static]`

See the constructor

Definition at line 68 of file AudioFrame.cpp.

References alize::Object::assertMemoryIsAllocated(), and AudioFrame().

String AudioFrame::getClassName ( ) const [virtual]

Returns the name of the class

Returns:: the name of the class of the object as a String

Implements alize::Object.

Definition at line 102 of file AudioFrame.cpp.

long AudioFrame::getData ( ) const

Returns the value of the frame

Returns:: the value of the frame

Definition at line 100 of file AudioFrame.cpp.

References _value.

bool AudioFrame::isValid ( ) const

Tells whether or not this AudioFrame is valid.

Returns:: true if this AudioFrame is valid; false otherwise.

Definition at line 94 of file AudioFrame.cpp.

References _isValid.

bool AudioFrame::operator!= ( const AudioFrame & c ) const

Definition at line 92 of file AudioFrame.cpp.

const AudioFrame & AudioFrame::operator= ( const AudioFrame & f )

Definition at line 78 of file AudioFrame.cpp.

References _isValid, and _value.

bool AudioFrame::operator== ( const AudioFrame & f ) const

Definition at line 85 of file AudioFrame.cpp.

References _isValid, and _value.

void AudioFrame::setData ( long v )

Sets the value of the frame

Parameters:

v the value

Definition at line 98 of file AudioFrame.cpp.

References _value.

Referenced by alize::AudioFileReader::readFrame().

void AudioFrame::setValidity ( bool validity )

Sets the validity of this AudioFrame.

Parameters:

validity true or false.

Definition at line 96 of file AudioFrame.cpp.

References _isValid.

Referenced by alize::AudioFileReader::readFrame().

String AudioFrame::toString ( ) const [virtual]

This method is frequently overridden in the derived classes. If it is not, it returns the name of the class of the object and the address of the object