#include <WritableWaveFileModel.h>

Inheritance diagram for WritableWaveFileModel:

[legend]

Collaboration diagram for WritableWaveFileModel:

[legend]

Public Types
typedef std::vector< Range >	RangeBlock

Public Slots
void	aboutToDelete ()

void	sourceModelAboutToBeDeleted ()

Signals
void	modelChanged ()
	Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly) More...

void	modelChangedWithin (int startFrame, int endFrame)
	Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly) More...

void	completionChanged ()
	Emitted when some internal processing has advanced a stage, but the model has not changed externally. More...

void	ready ()
	Emitted when internal processing is complete (i.e. More...

void	alignmentCompletionChanged ()
	Emitted when the completion percentage changes for the calculation of this model's alignment model. More...

void	aboutToBeDeleted ()
	Emitted when something notifies this model (through calling aboutToDelete() that it is about to delete it. More...

Public Member Functions
	WritableWaveFileModel (int sampleRate, int channels, QString path="")

	~WritableWaveFileModel ()

virtual bool	addSamples (float **samples, int count)
	Call addSamples to append a block of samples to the end of the file. More...

bool	isOK () const
	Return true if the model was constructed successfully. More...

bool	isReady (int *) const
	Return true if the model has finished loading or calculating all its data, for a model that is capable of calculating in a background thread. More...

virtual void	setCompletion (int completion)

virtual int	getCompletion () const

const ZoomConstraint *	getZoomConstraint () const
	If this model imposes a zoom constraint, i.e. More...

int	getFrameCount () const

int	getChannelCount () const
	Return the number of distinct channels for this model. More...

int	getSampleRate () const
	Return the frame rate in frames per second. More...

virtual Model *	clone () const
	Return a copy of this model. More...

float	getValueMinimum () const
	Return the minimum possible value found in this model type. More...

float	getValueMaximum () const
	Return the minimum possible value found in this model type. More...

virtual int	getStartFrame () const
	Return the first audio frame spanned by the model. More...

virtual int	getEndFrame () const
	Return the last audio frame spanned by the model. More...

void	setStartFrame (int startFrame)

virtual int	getData (int channel, int start, int count, float *buffer) const
	Get the specified set of samples from the given channel of the model in single-precision floating-point format. More...

virtual int	getData (int channel, int start, int count, double *buffer) const
	Get the specified set of samples from the given channel of the model in double-precision floating-point format. More...

virtual int	getData (int fromchannel, int tochannel, int start, int count, float **buffer) const
	Get the specified set of samples from given contiguous range of channels of the model in single-precision floating-point format. More...

virtual int	getSummaryBlockSize (int desired) const

virtual void	getSummaries (int channel, int start, int count, RangeBlock &ranges, int &blockSize) const
	Return ranges from the given start frame, corresponding to the given number of underlying sample frames, summarised at the given block size. More...

virtual Range	getSummary (int channel, int start, int count) const
	Return the range from the given start frame, corresponding to the given number of underlying sample frames, summarised at a block size equal to the distance between start and end frames. More...

QString	getTypeName () const
	Return the type of the model. More...

virtual void	toXml (QTextStream &out, QString indent="", QString extraAttributes="") const
	Stream this exportable object out to XML on a text stream. More...

virtual bool	canPlay () const

virtual QString	getDefaultPlayClipId () const

virtual QString	toDelimitedDataStringSubset (QString delimiter, int f0, int f1) const

virtual int	getNativeRate () const
	Return the frame rate of the underlying material, if the model itself has already been resampled. More...

virtual QString	getTitle () const
	Return the "work title" of the model, if known. More...

virtual QString	getMaker () const
	Return the "artist" or "maker" of the model, if known. More...

virtual QString	getLocation () const
	Return the location of the data in this model (e.g. More...

virtual void	abandon ()
	Mark the model as abandoning. More...

virtual bool	isAbandoning () const
	Query whether the model has been marked as abandoning. More...

virtual Model *	getSourceModel () const
	If this model was derived from another, return the model it was derived from. More...

virtual void	setSourceModel (Model *model)
	Set the source model for this model. More...

virtual void	setAlignment (AlignmentModel *alignment)
	Specify an aligment between this model's timeline and that of a reference model. More...

virtual const AlignmentModel *	getAlignment () const
	Retrieve the alignment model for this model. More...

virtual const Model *	getAlignmentReference () const
	Return the reference model for the current alignment timeline, if any. More...

virtual int	alignToReference (int frame) const
	Return the frame number of the reference model that corresponds to the given frame number in this model. More...

virtual int	alignFromReference (int referenceFrame) const
	Return the frame number in this model that corresponds to the given frame number of the reference model. More...

virtual int	getAlignmentCompletion () const
	Return the completion percentage for the alignment model: 100 if there is no alignment model or it has been entirely calculated, or less than 100 if it is still being calculated. More...

void	setRDFTypeURI (QString uri)
	Set the event, feature, or signal type URI for the features contained in this model, according to the Audio Features RDF ontology. More...

QString	getRDFTypeURI () const
	Retrieve the event, feature, or signal type URI for the features contained in this model, if previously set with setRDFTypeURI. More...

virtual QString	toDelimitedDataString (QString delimiter) const

virtual QString	toXmlString (QString indent="", QString extraAttributes="") const
	Convert this exportable object to XML in a string. More...

virtual bool	getDefaultPlayAudible () const

Static Public Member Functions
static QString	encodeEntities (QString)

static QString	encodeColour (int r, int g, int b)

static int	getObjectExportId (const void *)

Static Public Attributes
static const int	COMPLETION_UNKNOWN = -1

Protected Attributes
WaveFileModel *	m_model

WavFileWriter *	m_writer

WavFileReader *	m_reader

int	m_sampleRate

int	m_channels

int	m_frameCount

int	m_startFrame

int	m_completion

Model *	m_sourceModel

AlignmentModel *	m_alignment

QString	m_typeUri

bool	m_abandoning

bool	m_aboutToDelete

Detailed Description

Definition at line 24 of file WritableWaveFileModel.h.

Member Typedef Documentation

◆ RangeBlock

typedef std::vector<Range> RangeSummarisableTimeValueModel::RangeBlock

inherited

Definition at line 64 of file RangeSummarisableTimeValueModel.h.

Constructor & Destructor Documentation

◆ WritableWaveFileModel()

WritableWaveFileModel::WritableWaveFileModel	(	int	sampleRate,
		int	channels,
		QString	path = `""`
	)

Definition at line 33 of file WritableWaveFileModel.cpp.

References WavFileReader::getError(), WavFileWriter::getError(), TempDirectory::getInstance(), WavFileWriter::getPath(), WaveFileModel::isOK(), WavFileWriter::isOK(), m_model, m_reader, m_startFrame, m_writer, Model::modelChanged(), Model::modelChangedWithin(), WaveFileModel::setStartFrame(), and WavFileWriter::WriteToTarget.

◆ ~WritableWaveFileModel()

WritableWaveFileModel::~WritableWaveFileModel ( )

Definition at line 93 of file WritableWaveFileModel.cpp.

References m_model, m_reader, and m_writer.

Member Function Documentation

◆ addSamples()

bool WritableWaveFileModel::addSamples	(	float **	samples,
		int	count
	)

virtual

Call addSamples to append a block of samples to the end of the file.

Caller should also call setCompletion to update the progress of this file, if it has a known end point, and should call setCompletion(100) when the file has been written.

Definition at line 108 of file WritableWaveFileModel.cpp.

References AudioFileReader::getChannelCount(), WavFileWriter::getError(), m_frameCount, m_reader, m_writer, SVDEBUG, WavFileReader::updateFrameCount(), and WavFileWriter::writeSamples().

Referenced by RealTimeEffectModelTransformer::run().

◆ isOK()

bool WritableWaveFileModel::isOK ( ) const

virtual

Return true if the model was constructed successfully.

Classes that refer to the model should always test this before use.

Implements Model.

Definition at line 142 of file WritableWaveFileModel.cpp.

References WavFileWriter::isOK(), and m_writer.

◆ isReady()

bool WritableWaveFileModel::isReady ( int * completion ) const

virtual

Return true if the model has finished loading or calculating all its data, for a model that is capable of calculating in a background thread.

The default implementation is appropriate for a thread that does not background any work but carries out all its calculation from the constructor or accessors.

If "completion" is non-NULL, this function should return through it an estimated percentage value showing how far through the background operation it thinks it is (for progress reporting). If it has no way to calculate progress, it may return the special value COMPLETION_UNKNOWN.

Reimplemented from Model.

Definition at line 150 of file WritableWaveFileModel.cpp.

References m_completion.

◆ setCompletion()

void WritableWaveFileModel::setCompletion ( int completion )

virtual

Definition at line 157 of file WritableWaveFileModel.cpp.

References m_completion, m_reader, and WavFileReader::updateDone().

Referenced by RealTimeEffectModelTransformer::run().

◆ getCompletion()

virtual int WritableWaveFileModel::getCompletion ( ) const

inlinevirtual

Definition at line 44 of file WritableWaveFileModel.h.

References m_completion.

◆ getZoomConstraint()

const ZoomConstraint* WritableWaveFileModel::getZoomConstraint ( ) const

inlinevirtual

If this model imposes a zoom constraint, i.e.

some limit to the set of resolutions at which its data can meaningfully be displayed, then return it.

Reimplemented from Model.

Definition at line 46 of file WritableWaveFileModel.h.

◆ getFrameCount()

int WritableWaveFileModel::getFrameCount ( ) const

Definition at line 166 of file WritableWaveFileModel.cpp.

References m_frameCount.

Referenced by getEndFrame().

◆ getChannelCount()

int WritableWaveFileModel::getChannelCount ( ) const

inlinevirtual

Return the number of distinct channels for this model.

Implements DenseTimeValueModel.

Definition at line 52 of file WritableWaveFileModel.h.

References m_channels.

◆ getSampleRate()

int WritableWaveFileModel::getSampleRate ( ) const

inlinevirtual

Return the frame rate in frames per second.

Implements Model.

Definition at line 53 of file WritableWaveFileModel.h.

References m_sampleRate.

◆ clone()

Model * WritableWaveFileModel::clone ( ) const

virtual

Return a copy of this model.

If the model is not editable, this may be effectively a shallow copy. If the model is editable, however, this operation must properly copy all of the model's editable data.

In general this operation is not useful for non-editable dense models such as waveforms, because there may be no efficient copy operation implemented – for such models it is better not to copy at all.

Caller owns the returned value.

!!

Implements Model.

Definition at line 173 of file WritableWaveFileModel.cpp.

◆ getValueMinimum()

float WritableWaveFileModel::getValueMinimum ( ) const

inlinevirtual

Return the minimum possible value found in this model type.

(That is, the minimum that would be valid, not the minimum actually found in a particular model).

Implements DenseTimeValueModel.

Definition at line 57 of file WritableWaveFileModel.h.

◆ getValueMaximum()

float WritableWaveFileModel::getValueMaximum ( ) const

inlinevirtual

Return the minimum possible value found in this model type.

(That is, the minimum that would be valid, not the minimum actually found in a particular model).

Implements DenseTimeValueModel.

Definition at line 58 of file WritableWaveFileModel.h.

◆ getStartFrame()

virtual int WritableWaveFileModel::getStartFrame ( ) const

inlinevirtual

Return the first audio frame spanned by the model.

Implements Model.

Definition at line 60 of file WritableWaveFileModel.h.

References m_startFrame.

◆ getEndFrame()

virtual int WritableWaveFileModel::getEndFrame ( ) const

inlinevirtual

Return the last audio frame spanned by the model.

Implements Model.

Definition at line 61 of file WritableWaveFileModel.h.

References getFrameCount(), and m_startFrame.

◆ setStartFrame()

void WritableWaveFileModel::setStartFrame ( int startFrame )

Definition at line 101 of file WritableWaveFileModel.cpp.

References m_model, m_startFrame, and WaveFileModel::setStartFrame().

Referenced by RealTimeEffectModelTransformer::run().

◆ getData() [1/3]

int WritableWaveFileModel::getData	(	int	channel,
		int	start,
		int	count,
		float *	buffer
	)		const

virtual

Get the specified set of samples from the given channel of the model in single-precision floating-point format.

Return the number of samples actually retrieved. If the channel is given as -1, mix all available channels and return the result.

Implements DenseTimeValueModel.

Definition at line 180 of file WritableWaveFileModel.cpp.

References WaveFileModel::getChannelCount(), WaveFileModel::getData(), and m_model.

◆ getData() [2/3]

int WritableWaveFileModel::getData	(	int	channel,
		int	start,
		int	count,
		double *	buffer
	)		const

virtual

Get the specified set of samples from the given channel of the model in double-precision floating-point format.

Return the number of samples actually retrieved. If the channel is given as -1, mix all available channels and return the result.

Implements DenseTimeValueModel.

Definition at line 188 of file WritableWaveFileModel.cpp.

References WaveFileModel::getChannelCount(), WaveFileModel::getData(), and m_model.

◆ getData() [3/3]

int WritableWaveFileModel::getData	(	int	fromchannel,
		int	tochannel,
		int	start,
		int	count,
		float **	buffers
	)		const

virtual

Get the specified set of samples from given contiguous range of channels of the model in single-precision floating-point format.

Return the number of sample frames actually retrieved.

Implements DenseTimeValueModel.

Definition at line 196 of file WritableWaveFileModel.cpp.

References WaveFileModel::getChannelCount(), WaveFileModel::getData(), and m_model.

◆ getSummaryBlockSize()

int WritableWaveFileModel::getSummaryBlockSize ( int desired ) const

virtual

Implements RangeSummarisableTimeValueModel.

Definition at line 205 of file WritableWaveFileModel.cpp.

References WaveFileModel::getSummaryBlockSize(), and m_model.

◆ getSummaries()

void WritableWaveFileModel::getSummaries	(	int	channel,
		int	start,
		int	count,
		RangeBlock &	ranges,
		int &	blockSize
	)		const

virtual

Return ranges from the given start frame, corresponding to the given number of underlying sample frames, summarised at the given block size.

duration / blockSize ranges should ideally be returned.

If the given block size is not supported by this model (according to its zoom constraint), also modify the blockSize parameter so as to return the block size that was actually obtained.

Implements RangeSummarisableTimeValueModel.

Definition at line 212 of file WritableWaveFileModel.cpp.

References WaveFileModel::getChannelCount(), WaveFileModel::getSummaries(), and m_model.

◆ getSummary()

WritableWaveFileModel::Range WritableWaveFileModel::getSummary	(	int	channel,
		int	start,
		int	count
	)		const

virtual

Return the range from the given start frame, corresponding to the given number of underlying sample frames, summarised at a block size equal to the distance between start and end frames.

Implements RangeSummarisableTimeValueModel.

Definition at line 222 of file WritableWaveFileModel.cpp.

References WaveFileModel::getChannelCount(), WaveFileModel::getSummary(), and m_model.

◆ getTypeName()

QString WritableWaveFileModel::getTypeName ( ) const

inlinevirtual

Return the type of the model.

For display purposes only.

Reimplemented from RangeSummarisableTimeValueModel.

Definition at line 82 of file WritableWaveFileModel.h.

◆ toXml()

void WritableWaveFileModel::toXml	(	QTextStream &	stream,
		QString	indent = `""`,
		QString	extraAttributes = `""`
	)		const

virtual

Stream this exportable object out to XML on a text stream.

Reimplemented from Model.

Definition at line 229 of file WritableWaveFileModel.cpp.

References XmlExportable::encodeEntities(), WaveFileModel::getChannelCount(), WavFileWriter::getPath(), m_model, m_writer, and Model::toXml().

◆ canPlay()

virtual bool DenseTimeValueModel::canPlay ( ) const

inlinevirtualinherited

Reimplemented from Playable.

Definition at line 87 of file DenseTimeValueModel.h.

◆ getDefaultPlayClipId()

virtual QString DenseTimeValueModel::getDefaultPlayClipId ( ) const

inlinevirtualinherited

Reimplemented from Playable.

Definition at line 88 of file DenseTimeValueModel.h.

◆ toDelimitedDataStringSubset()

QString DenseTimeValueModel::toDelimitedDataStringSubset	(	QString	delimiter,
		int	f0,
		int	f1
	)		const

virtualinherited

Reimplemented from Model.

Definition at line 32 of file DenseTimeValueModel.cpp.

References DenseTimeValueModel::getChannelCount(), and DenseTimeValueModel::getData().

◆ getNativeRate()

virtual int Model::getNativeRate ( ) const

inlinevirtualinherited

Return the frame rate of the underlying material, if the model itself has already been resampled.

Reimplemented in WaveFileModel.

Definition at line 69 of file Model.h.

References Model::getSampleRate().

◆ getTitle()

QString Model::getTitle ( ) const

virtualinherited

Return the "work title" of the model, if known.

Reimplemented in WaveFileModel.

Definition at line 153 of file Model.cpp.

References Model::getTitle(), and Model::m_sourceModel.

Referenced by Model::getTitle().

◆ getMaker()

QString Model::getMaker ( ) const

virtualinherited

Return the "artist" or "maker" of the model, if known.

Reimplemented in WaveFileModel.

Definition at line 160 of file Model.cpp.

References Model::getMaker(), and Model::m_sourceModel.

Referenced by Model::getMaker().

◆ getLocation()

QString Model::getLocation ( ) const

virtualinherited

Return the location of the data in this model (e.g.

source URL). This should not normally be returned for editable models that have been edited.

Reimplemented in WaveFileModel.

Definition at line 167 of file Model.cpp.

References Model::getLocation(), and Model::m_sourceModel.

Referenced by Model::getLocation().

◆ abandon()

virtual void Model::abandon ( )

inlinevirtualinherited

Mark the model as abandoning.

This means that the application no longer needs it, so it can stop doing any background calculations it may be involved in. Note that as far as the model API is concerned, this does nothing more than tell the model to return true from isAbandoning(). The actual response to this will depend on the model's context – it's possible nothing at all will change.

Definition at line 118 of file Model.h.

References Model::m_abandoning.

◆ isAbandoning()

virtual bool Model::isAbandoning ( ) const

inlinevirtualinherited

Query whether the model has been marked as abandoning.

Definition at line 125 of file Model.h.

References Model::m_abandoning.

Referenced by FeatureExtractionModelTransformer::setCompletion().

◆ getSourceModel()

virtual Model* Model::getSourceModel ( ) const

inlinevirtualinherited

If this model was derived from another, return the model it was derived from.

The assumption is that the source model's alignment will also apply to this model, unless some other property (such as a specific alignment model set on this model) indicates otherwise.

Definition at line 165 of file Model.h.

References Model::m_sourceModel.

◆ setSourceModel()

void Model::setSourceModel ( Model * model )

virtualinherited

Set the source model for this model.

Definition at line 42 of file Model.cpp.

References Model::aboutToBeDeleted(), Model::alignmentCompletionChanged(), Model::m_sourceModel, and Model::sourceModelAboutToBeDeleted().

Referenced by FeatureExtractionModelTransformer::createOutputModels(), FFTModel::FFTModel(), and RDFImporterImpl::getDataModelsSparse().

◆ setAlignment()

void Model::setAlignment ( AlignmentModel * alignment )

virtualinherited

Specify an aligment between this model's timeline and that of a reference model.

The alignment model records both the reference and the alignment. This model takes ownership of the alignment model.

Definition at line 82 of file Model.cpp.

References Model::aboutToDelete(), Model::alignmentCompletionChanged(), Model::completionChanged(), and Model::m_alignment.

◆ getAlignment()

const AlignmentModel * Model::getAlignment ( ) const

virtualinherited

Retrieve the alignment model for this model.

This is not a generally useful function, as the alignment you really want may be performed by the source model instead. You should normally use getAlignmentReference, alignToReference and alignFromReference instead of this. The main intended application for this function is in streaming out alignments to the session file.

Definition at line 94 of file Model.cpp.

References Model::m_alignment.

◆ getAlignmentReference()

const Model * Model::getAlignmentReference ( ) const

virtualinherited

Return the reference model for the current alignment timeline, if any.

Definition at line 100 of file Model.cpp.

References Model::getAlignmentReference(), AlignmentModel::getReferenceModel(), Model::m_alignment, and Model::m_sourceModel.

Referenced by Model::getAlignmentReference().

◆ alignToReference()

int Model::alignToReference ( int frame ) const

virtualinherited

Return the frame number of the reference model that corresponds to the given frame number in this model.

Definition at line 110 of file Model.cpp.

References Model::alignToReference(), Model::getEndFrame(), AlignmentModel::getReferenceModel(), Model::m_alignment, Model::m_sourceModel, and AlignmentModel::toReference().

Referenced by Model::alignToReference().

◆ alignFromReference()

int Model::alignFromReference ( int referenceFrame ) const

virtualinherited

Return the frame number in this model that corresponds to the given frame number of the reference model.

Definition at line 125 of file Model.cpp.

References Model::alignFromReference(), AlignmentModel::fromReference(), Model::getEndFrame(), Model::m_alignment, and Model::m_sourceModel.

Referenced by Model::alignFromReference().

◆ getAlignmentCompletion()

int Model::getAlignmentCompletion ( ) const

virtualinherited

Return the completion percentage for the alignment model: 100 if there is no alignment model or it has been entirely calculated, or less than 100 if it is still being calculated.

Definition at line 139 of file Model.cpp.

References Model::getAlignmentCompletion(), AlignmentModel::isReady(), Model::m_alignment, and Model::m_sourceModel.

Referenced by Model::getAlignmentCompletion().

◆ setRDFTypeURI()

void Model::setRDFTypeURI ( QString uri )

inlineinherited

Set the event, feature, or signal type URI for the features contained in this model, according to the Audio Features RDF ontology.

Definition at line 223 of file Model.h.

References Model::m_typeUri.

Referenced by FeatureExtractionModelTransformer::createOutputModels(), FeatureExtractionModelTransformer::getAdditionalModel(), RDFImporterImpl::getDataModelsDense(), and RDFImporterImpl::getDataModelsSparse().

◆ getRDFTypeURI()

QString Model::getRDFTypeURI ( ) const

inlineinherited

Retrieve the event, feature, or signal type URI for the features contained in this model, if previously set with setRDFTypeURI.

Definition at line 230 of file Model.h.

References Model::m_typeUri.

Referenced by FeatureExtractionModelTransformer::getAdditionalModel().

◆ toDelimitedDataString()

virtual QString Model::toDelimitedDataString ( QString delimiter ) const

inlinevirtualinherited

Reimplemented in EditableDenseThreeDimensionalModel, SparseModel< PointType >, SparseModel< FlexiNote >, SparseModel< Note >, SparseModel< PathPoint >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, and SparseModel< RegionRec >.

Definition at line 236 of file Model.h.

References Model::getEndFrame(), Model::getStartFrame(), and Model::toDelimitedDataStringSubset().

Referenced by CSVFileWriter::write().

◆ aboutToDelete

void Model::aboutToDelete ( )

slotinherited

Definition at line 60 of file Model.cpp.

References Model::aboutToBeDeleted(), and Model::m_aboutToDelete.

Referenced by AlignmentModel::pathChanged(), AlignmentModel::pathCompletionChanged(), Model::setAlignment(), AlignmentModel::setPath(), AlignmentModel::~AlignmentModel(), and Model::~Model().

◆ sourceModelAboutToBeDeleted

void Model::sourceModelAboutToBeDeleted ( )

slotinherited

Definition at line 76 of file Model.cpp.

References Model::m_sourceModel.

Referenced by Model::setSourceModel().

◆ modelChanged

void Model::modelChanged ( )

signalinherited

Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly)

Referenced by SparseValueModel< RegionRec >::addPoint(), WaveFileModel::cacheFilled(), SparseValueModel< RegionRec >::deletePoint(), Dense3DModelPeakCache::Dense3DModelPeakCache(), WaveFileModel::fillTimerTimedOut(), EditableDenseThreeDimensionalModel::setBinName(), EditableDenseThreeDimensionalModel::setBinNames(), EditableDenseThreeDimensionalModel::setColumn(), EditableDenseThreeDimensionalModel::setCompletion(), and WritableWaveFileModel().

◆ modelChangedWithin

void Model::modelChangedWithin	(	int	startFrame,
		int	endFrame
	)

signalinherited

Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly)

Referenced by WaveFileModel::cacheFilled(), WaveFileModel::fillTimerTimedOut(), EditableDenseThreeDimensionalModel::setColumn(), EditableDenseThreeDimensionalModel::setCompletion(), and WritableWaveFileModel().

◆ completionChanged

void Model::completionChanged ( )

signalinherited

Emitted when some internal processing has advanced a stage, but the model has not changed externally.

Views should respond by updating any progress meters or other monitoring, but not refreshing the actual view.

Referenced by Model::setAlignment(), and EditableDenseThreeDimensionalModel::setCompletion().

◆ ready

void Model::ready ( )

signalinherited

Emitted when internal processing is complete (i.e.

when isReady() would return true, with completion at 100).

Referenced by WaveFileModel::cacheFilled(), WaveFileModel::isReady(), AggregateWaveModel::isReady(), and SparseModel< RegionRec >::isReady().

◆ alignmentCompletionChanged

void Model::alignmentCompletionChanged ( )

signalinherited

Emitted when the completion percentage changes for the calculation of this model's alignment model.

Referenced by Model::setAlignment(), and Model::setSourceModel().

◆ aboutToBeDeleted

void Model::aboutToBeDeleted ( )

signalinherited

Emitted when something notifies this model (through calling aboutToDelete() that it is about to delete it.

Note that this depends on an external agent such as a Document object or owning model telling the model that it is about to delete it; there is nothing in the model to guarantee that this signal will be emitted before the actual deletion.

Referenced by Model::aboutToDelete(), Dense3DModelPeakCache::Dense3DModelPeakCache(), and Model::setSourceModel().

◆ toXmlString()

QString XmlExportable::toXmlString	(	QString	indent = `""`,
		QString	extraAttributes = `""`
	)		const

virtualinherited

Convert this exportable object to XML in a string.

The default implementation calls toXml and returns the result as a string. Do not override this unless you really know what you're doing.

Definition at line 25 of file XmlExportable.cpp.

References XmlExportable::toXml().

Referenced by ModelTransformerFactory::getConfigurationForTransform(), and RDFTransformFactoryImpl::getTransforms().

◆ encodeEntities()

QString XmlExportable::encodeEntities ( QString s )

staticinherited

Definition at line 41 of file XmlExportable.cpp.

Referenced by TextMatcher::test(), PluginXml::toXml(), OneDimensionalPoint::toXml(), TimeValuePoint::toXml(), ImagePoint::toXml(), TextPoint::toXml(), RegionRec::toXml(), Note::toXml(), FlexiNote::toXml(), toXml(), WaveFileModel::toXml(), SparseValueModel< RegionRec >::toXml(), Transform::toXml(), and Model::toXml().

◆ encodeColour()

QString XmlExportable::encodeColour	(	int	r,
		int	g,
		int	b
	)

staticinherited

Definition at line 54 of file XmlExportable.cpp.

◆ getObjectExportId()

int XmlExportable::getObjectExportId ( const void * object )

staticinherited

Definition at line 71 of file XmlExportable.cpp.

References mutex.

Referenced by FFTDataServer::generateFileBasename(), AlignmentModel::toXml(), EditableDenseThreeDimensionalModel::toXml(), and Model::toXml().

◆ getDefaultPlayAudible()

virtual bool Playable::getDefaultPlayAudible ( ) const

inlinevirtualinherited

Reimplemented in SparseTimeValueModel.

Definition at line 28 of file Playable.h.

Referenced by PlayParameterRepository::addPlayable().

Member Data Documentation

◆ m_model

WaveFileModel* WritableWaveFileModel::m_model

protected

Definition at line 89 of file WritableWaveFileModel.h.

Referenced by getData(), getSummaries(), getSummary(), getSummaryBlockSize(), setStartFrame(), toXml(), WritableWaveFileModel(), and ~WritableWaveFileModel().

◆ m_writer

WavFileWriter* WritableWaveFileModel::m_writer

protected

Definition at line 90 of file WritableWaveFileModel.h.

Referenced by addSamples(), isOK(), toXml(), WritableWaveFileModel(), and ~WritableWaveFileModel().

◆ m_reader

WavFileReader* WritableWaveFileModel::m_reader

protected

Definition at line 91 of file WritableWaveFileModel.h.

Referenced by addSamples(), setCompletion(), WritableWaveFileModel(), and ~WritableWaveFileModel().

◆ m_sampleRate

int WritableWaveFileModel::m_sampleRate

protected

Definition at line 92 of file WritableWaveFileModel.h.

Referenced by getSampleRate().

◆ m_channels

int WritableWaveFileModel::m_channels

protected

Definition at line 93 of file WritableWaveFileModel.h.

Referenced by getChannelCount().

◆ m_frameCount

int WritableWaveFileModel::m_frameCount

protected

Definition at line 94 of file WritableWaveFileModel.h.

Referenced by addSamples(), and getFrameCount().

◆ m_startFrame

int WritableWaveFileModel::m_startFrame

protected

Definition at line 95 of file WritableWaveFileModel.h.

Referenced by getEndFrame(), getStartFrame(), setStartFrame(), and WritableWaveFileModel().

◆ m_completion

int WritableWaveFileModel::m_completion

protected

Definition at line 96 of file WritableWaveFileModel.h.

Referenced by getCompletion(), isReady(), and setCompletion().

◆ COMPLETION_UNKNOWN

const int Model::COMPLETION_UNKNOWN = -1

staticinherited

Definition at line 147 of file Model.h.

◆ m_sourceModel

Model* Model::m_sourceModel

protectedinherited

Definition at line 301 of file Model.h.

Referenced by Model::alignFromReference(), Model::alignToReference(), Model::getAlignmentCompletion(), Model::getAlignmentReference(), Model::getLocation(), Model::getMaker(), Model::getSourceModel(), Model::getTitle(), Model::setSourceModel(), FFTModel::sourceModelAboutToBeDeleted(), and Model::sourceModelAboutToBeDeleted().

◆ m_alignment

AlignmentModel* Model::m_alignment

protectedinherited

Definition at line 302 of file Model.h.

Referenced by Model::alignFromReference(), Model::alignToReference(), Model::getAlignment(), Model::getAlignmentCompletion(), Model::getAlignmentReference(), Model::setAlignment(), and Model::~Model().

◆ m_typeUri

QString Model::m_typeUri

protectedinherited

Definition at line 303 of file Model.h.

Referenced by Model::getRDFTypeURI(), and Model::setRDFTypeURI().

◆ m_abandoning

bool Model::m_abandoning

protectedinherited

Definition at line 304 of file Model.h.

Referenced by Model::abandon(), and Model::isAbandoning().

◆ m_aboutToDelete

bool Model::m_aboutToDelete

protectedinherited

Definition at line 305 of file Model.h.

Referenced by Model::aboutToDelete(), and Model::~Model().

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

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ RangeBlock

Constructor & Destructor Documentation

◆ WritableWaveFileModel()

◆ ~WritableWaveFileModel()

Member Function Documentation

◆ addSamples()

◆ isOK()

◆ isReady()

◆ setCompletion()

◆ getCompletion()

◆ getZoomConstraint()

◆ getFrameCount()

◆ getChannelCount()

◆ getSampleRate()

◆ clone()

◆ getValueMinimum()

◆ getValueMaximum()

◆ getStartFrame()

◆ getEndFrame()

◆ setStartFrame()

◆ getData() [1/3]

◆ getData() [2/3]

◆ getData() [3/3]

◆ getSummaryBlockSize()

◆ getSummaries()

◆ getSummary()

◆ getTypeName()

◆ toXml()

◆ canPlay()

◆ getDefaultPlayClipId()

◆ toDelimitedDataStringSubset()

◆ getNativeRate()

◆ getTitle()

◆ getMaker()

◆ getLocation()

◆ abandon()

◆ isAbandoning()

◆ getSourceModel()

◆ setSourceModel()

◆ setAlignment()

◆ getAlignment()

◆ getAlignmentReference()

◆ alignToReference()

◆ alignFromReference()

◆ getAlignmentCompletion()

◆ setRDFTypeURI()

◆ getRDFTypeURI()

◆ toDelimitedDataString()

◆ aboutToDelete

◆ sourceModelAboutToBeDeleted

◆ modelChanged

◆ modelChangedWithin

◆ completionChanged

◆ ready

◆ alignmentCompletionChanged

◆ aboutToBeDeleted

◆ toXmlString()

◆ encodeEntities()

◆ encodeColour()

◆ getObjectExportId()

◆ getDefaultPlayAudible()

Member Data Documentation

◆ m_model

◆ m_writer

◆ m_reader

◆ m_sampleRate

◆ m_channels

◆ m_frameCount

◆ m_startFrame

◆ m_completion

◆ COMPLETION_UNKNOWN