Base class for models containing dense two-dimensional data (value against time) that may be meaningfully represented in a zoomed view using min/max range summaries. More...

#include <RangeSummarisableTimeValueModel.h>

Inheritance diagram for RangeSummarisableTimeValueModel:

[legend]

Collaboration diagram for RangeSummarisableTimeValueModel:

[legend]

Classes
class	Range

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
	RangeSummarisableTimeValueModel ()

virtual void	getSummaries (int channel, int start, int count, RangeBlock &ranges, int &blockSize) const =0
	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 =0
	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...

virtual int	getSummaryBlockSize (int desired) const =0

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

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

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

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

virtual int	getData (int channel, int start, int count, float *buffer) const =0
	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 =0
	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 **buffers) const =0
	Get the specified set of samples from given contiguous range of channels of the model in single-precision floating-point format. More...

virtual bool	canPlay () const

virtual QString	getDefaultPlayClipId () const

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

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

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

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

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

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 Model *	clone () const =0
	Return a copy of this model. 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 bool	isReady (int *completion=0) 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 const ZoomConstraint *	getZoomConstraint () const
	If this model imposes a zoom constraint, i.e. 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 void	toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
	Stream this exportable object out to XML on a text stream. 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
Model *	m_sourceModel

AlignmentModel *	m_alignment

QString	m_typeUri

bool	m_abandoning

bool	m_aboutToDelete

Detailed Description

Base class for models containing dense two-dimensional data (value against time) that may be meaningfully represented in a zoomed view using min/max range summaries.

Audio waveform data is an obvious example: think "peaks and minima" for "ranges".

Definition at line 33 of file RangeSummarisableTimeValueModel.h.

Member Typedef Documentation

◆ RangeBlock

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

Definition at line 64 of file RangeSummarisableTimeValueModel.h.

Constructor & Destructor Documentation

◆ RangeSummarisableTimeValueModel()

RangeSummarisableTimeValueModel::RangeSummarisableTimeValueModel ( )

inline

Definition at line 38 of file RangeSummarisableTimeValueModel.h.

Member Function Documentation

◆ getSummaries()

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

pure 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.

Implemented in WaveFileModel, WritableWaveFileModel, and AggregateWaveModel.

◆ getSummary()

virtual Range RangeSummarisableTimeValueModel::getSummary	(	int	channel,
		int	start,
		int	count
	)		const

pure 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.

Implemented in WaveFileModel, AggregateWaveModel, and WritableWaveFileModel.

◆ getSummaryBlockSize()

virtual int RangeSummarisableTimeValueModel::getSummaryBlockSize ( int desired ) const

pure virtual

Implemented in WaveFileModel, WritableWaveFileModel, and AggregateWaveModel.

◆ getTypeName()

QString RangeSummarisableTimeValueModel::getTypeName ( ) const

inlinevirtual

Return the type of the model.

For display purposes only.

Reimplemented from DenseTimeValueModel.

Reimplemented in WaveFileModel, and WritableWaveFileModel.

Definition at line 90 of file RangeSummarisableTimeValueModel.h.

◆ getValueMinimum()

virtual float DenseTimeValueModel::getValueMinimum ( ) const

pure virtualinherited

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).

Implemented in AggregateWaveModel, WaveFileModel, and WritableWaveFileModel.

◆ getValueMaximum()

virtual float DenseTimeValueModel::getValueMaximum ( ) const

pure virtualinherited

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).

Implemented in AggregateWaveModel, WaveFileModel, and WritableWaveFileModel.

◆ getChannelCount()

virtual int DenseTimeValueModel::getChannelCount ( ) const

pure virtualinherited

Return the number of distinct channels for this model.

Implemented in AggregateWaveModel, WritableWaveFileModel, and WaveFileModel.

Referenced by FFTDataServer::fillColumn(), FeatureExtractionModelTransformer::getFrames(), FFTDataServer::getFuzzyInstance(), FeatureExtractionModelTransformer::initialise(), RealTimeEffectModelTransformer::RealTimeEffectModelTransformer(), RealTimeEffectModelTransformer::run(), FeatureExtractionModelTransformer::run(), DenseTimeValueModel::toDelimitedDataStringSubset(), and WavFileWriter::writeModel().

◆ getData() [1/3]

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

pure virtualinherited

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.

Implemented in WaveFileModel, WritableWaveFileModel, and AggregateWaveModel.

Referenced by FFTDataServer::fillColumn(), FeatureExtractionModelTransformer::getFrames(), RealTimeEffectModelTransformer::run(), DenseTimeValueModel::toDelimitedDataStringSubset(), and WavFileWriter::writeModel().

◆ getData() [2/3]

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

pure virtualinherited

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.

Implemented in WaveFileModel, WritableWaveFileModel, and AggregateWaveModel.

◆ getData() [3/3]

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

pure virtualinherited

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.

Implemented in WaveFileModel, WritableWaveFileModel, and AggregateWaveModel.

◆ 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().

◆ isOK()

virtual bool Model::isOK ( ) const

pure virtualinherited

Return true if the model was constructed successfully.

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

Implemented in FFTModel, EditableDenseThreeDimensionalModel, SparseModel< PointType >, SparseModel< FlexiNote >, SparseModel< Note >, SparseModel< PathPoint >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, SparseModel< RegionRec >, AggregateWaveModel, WaveFileModel, WritableWaveFileModel, AlignmentModel, and Dense3DModelPeakCache.

Referenced by Dense3DModelPeakCache::isOK(), and Model::isReady().

◆ getStartFrame()

virtual int Model::getStartFrame ( ) const

pure virtualinherited

◆ getEndFrame()

virtual int Model::getEndFrame ( ) const

pure virtualinherited

Return the last audio frame spanned by the model.

Implemented in FFTModel, AggregateWaveModel, WaveFileModel, WritableWaveFileModel, EditableDenseThreeDimensionalModel, SparseModel< PointType >, SparseModel< FlexiNote >, SparseModel< Note >, SparseModel< PathPoint >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, SparseModel< RegionRec >, Dense3DModelPeakCache, and AlignmentModel.

Referenced by Model::alignFromReference(), Model::alignToReference(), FFTDataServer::FFTDataServer(), AlignmentModel::getEndFrame(), Dense3DModelPeakCache::getEndFrame(), FFTDataServer::getFillExtent(), RealTimeEffectModelTransformer::run(), FeatureExtractionModelTransformer::run(), FFTDataServer::FillThread::run(), Model::toDelimitedDataString(), Model::toXml(), and WavFileWriter::writeModel().

◆ getSampleRate()

virtual int Model::getSampleRate ( ) const

pure virtualinherited

Return the frame rate in frames per second.

Implemented in FFTModel, AggregateWaveModel, EditableDenseThreeDimensionalModel, SparseModel< PointType >, WritableWaveFileModel, SparseModel< FlexiNote >, SparseModel< Note >, SparseModel< PathPoint >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, SparseModel< RegionRec >, WaveFileModel, AlignmentModel, and Dense3DModelPeakCache.

Referenced by FeatureExtractionModelTransformer::addFeature(), AlignmentModel::constructPath(), FeatureExtractionModelTransformer::createOutputModels(), Dense3DModelPeakCache::Dense3DModelPeakCache(), FFTModel::estimateStableFrequency(), ModelTransformerFactory::getConfigurationForTransform(), DenseThreeDimensionalModel::getData(), DenseThreeDimensionalModel::getFrameForRow(), Model::getNativeRate(), DenseThreeDimensionalModel::getRowForFrame(), Dense3DModelPeakCache::getSampleRate(), AlignmentModel::getSampleRate(), FFTModel::getSampleRate(), FeatureExtractionModelTransformer::initialise(), RealTimeEffectModelTransformer::RealTimeEffectModelTransformer(), RealTimeEffectModelTransformer::run(), FeatureExtractionModelTransformer::run(), Model::toXml(), and RDFExporter::write().

◆ 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().

◆ clone()

virtual Model* Model::clone ( ) const

pure virtualinherited

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.

Implemented in FFTModel, EditableDenseThreeDimensionalModel, AggregateWaveModel, SparseModel< PointType >, WaveFileModel, WritableWaveFileModel, SparseModel< FlexiNote >, SparseModel< Note >, SparseModel< PathPoint >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, SparseModel< RegionRec >, Dense3DModelPeakCache, and AlignmentModel.

Referenced by AlignmentModel::clone().

◆ 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().

◆ isReady()

virtual bool Model::isReady ( int * completion = 0 ) const

inlinevirtualinherited

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 in SparseModel< PointType >, SparseModel< FlexiNote >, SparseModel< Note >, SparseModel< PathPoint >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, SparseModel< RegionRec >, AlignmentModel, AggregateWaveModel, WaveFileModel, and WritableWaveFileModel.

Definition at line 142 of file Model.h.

References Model::isOK().

Referenced by FFTDataServer::fillColumn(), RealTimeEffectModelTransformer::run(), FeatureExtractionModelTransformer::run(), and FFTDataServer::FillThread::run().

◆ getZoomConstraint()

virtual const ZoomConstraint* Model::getZoomConstraint ( ) const

inlinevirtualinherited

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 in AggregateWaveModel, WritableWaveFileModel, AlignmentModel, and WaveFileModel.

Definition at line 154 of file Model.h.

◆ 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().

◆ toXml()

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

virtualinherited

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

Implements XmlExportable.

Reimplemented in EditableDenseThreeDimensionalModel, SparseModel< PointType >, SparseModel< FlexiNote >, SparseModel< Note >, SparseModel< PathPoint >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, SparseModel< RegionRec >, FlexiNoteModel, NoteModel, RegionModel, SparseValueModel< PointType >, SparseValueModel< FlexiNote >, SparseValueModel< Note >, SparseValueModel< TimeValuePoint >, SparseValueModel< RegionRec >, ImageModel, TextModel, WaveFileModel, WritableWaveFileModel, AggregateWaveModel, PathModel, and AlignmentModel.

Definition at line 174 of file Model.cpp.

References XmlExportable::encodeEntities(), Model::getEndFrame(), XmlExportable::getObjectExportId(), Model::getSampleRate(), and Model::getStartFrame().

Referenced by AlignmentModel::toXml(), WritableWaveFileModel::toXml(), WaveFileModel::toXml(), SparseModel< RegionRec >::toXml(), and EditableDenseThreeDimensionalModel::toXml().

◆ 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::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::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(), WritableWaveFileModel::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

◆ 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 file:

RangeSummarisableTimeValueModel.h

Classes

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

◆ RangeSummarisableTimeValueModel()

Member Function Documentation

◆ getSummaries()

◆ getSummary()

◆ getSummaryBlockSize()

◆ getTypeName()

◆ getValueMinimum()

◆ getValueMaximum()

◆ getChannelCount()

◆ getData() [1/3]

◆ getData() [2/3]

◆ getData() [3/3]

◆ canPlay()

◆ getDefaultPlayClipId()

◆ toDelimitedDataStringSubset()

◆ isOK()

◆ getStartFrame()

◆ getEndFrame()

◆ getSampleRate()

◆ getNativeRate()

◆ getTitle()

◆ getMaker()

◆ getLocation()

◆ clone()

◆ abandon()

◆ isAbandoning()

◆ isReady()

◆ getZoomConstraint()

◆ getSourceModel()

◆ setSourceModel()

◆ setAlignment()

◆ getAlignment()

◆ getAlignmentReference()

◆ alignToReference()

◆ alignFromReference()

◆ getAlignmentCompletion()

◆ setRDFTypeURI()

◆ getRDFTypeURI()

◆ toXml()

◆ toDelimitedDataString()

◆ aboutToDelete

◆ sourceModelAboutToBeDeleted

◆ modelChanged

◆ modelChangedWithin

◆ completionChanged

◆ ready

◆ alignmentCompletionChanged

◆ aboutToBeDeleted

◆ toXmlString()

◆ encodeEntities()

◆ encodeColour()

◆ getObjectExportId()

◆ getDefaultPlayAudible()

Member Data Documentation

◆ COMPLETION_UNKNOWN

◆ m_sourceModel

◆ m_alignment

◆ m_typeUri

◆ m_abandoning

◆ m_aboutToDelete