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:

Collaboration diagram for RangeSummarisableTimeValueModel:

Classes
class	Range

Public Types
typedef std::vector< Range >	RangeBlock

typedef Id	ModelId

typedef TypedId< Model >	Id

enum	{ NO_ID = -1 }

typedef int	ExportId

Signals
void	modelChanged (ModelId myId)
	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 (ModelId myId, sv_frame_t startFrame, sv_frame_t 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 (ModelId myId)
	Emitted when some internal processing has advanced a stage, but the model has not changed externally. More...

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

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

Public Member Functions
	RangeSummarisableTimeValueModel ()

virtual void	getSummaries (int channel, sv_frame_t start, sv_frame_t 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, sv_frame_t start, sv_frame_t 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 override
	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 floatvec_t	getData (int channel, sv_frame_t start, sv_frame_t count) const =0
	Get the specified set of samples from the given channel of the model in single-precision floating-point format. More...

virtual std::vector< floatvec_t >	getMultiChannelData (int fromchannel, int tochannel, sv_frame_t start, sv_frame_t count) const =0
	Get the specified set of samples from given contiguous range of channels of the model in single-precision floating-point format. More...

bool	canPlay () const override

QString	getDefaultPlayClipId () const override

QVector< QString >	getStringExportHeaders (DataExportOptions options) const override
	Return a label for each column that would be written by toStringExportRows. More...

QVector< QVector< QString > >	toStringExportRows (DataExportOptions options, sv_frame_t startFrame, sv_frame_t duration) const override
	Emit events starting within the given range as string rows ready for conversion to an e.g. More...

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

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

sv_frame_t	getEndFrame () const
	Return the audio frame at the end of the model, i.e. More...

virtual sv_frame_t	getTrueEndFrame () const =0
	Return the audio frame at the end of the model. More...

void	extendEndFrame (sv_frame_t to)
	Extend the end of the model. More...

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

virtual sv_samplerate_t	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 bool	isSparse () const
	Return true if this is a sparse model. More...

virtual bool	isReady (int *cp=nullptr) 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 int	getCompletion () const =0
	Return an estimated percentage value showing how far through any background operation used to calculate or load the model data the model thinks it is. More...

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

virtual ModelId	getSourceModel () const
	If this model was derived from another, return the id of the model it was derived from. More...

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

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

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

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

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

virtual sv_frame_t	alignFromReference (sv_frame_t 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...

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

ExportId	getExportId () const
	Return the numerical export identifier for this object. More...

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)

Protected Member Functions
Id	getId () const
	Return an id for this object. More...

int	getUntypedId () const
	Return an id for this object. More...

Protected Attributes
QMutex	m_mutex

ModelId	m_sourceModel

ModelId	m_alignmentModel

QString	m_typeUri

std::atomic< sv_frame_t >	m_extendTo

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 32 of file RangeSummarisableTimeValueModel.h.

Member Typedef Documentation

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

Definition at line 76 of file RangeSummarisableTimeValueModel.h.

typedef Id Model::ModelId

inherited

Definition at line 59 of file Model.h.

typedef TypedId<Model > WithTypedId< Model >::Id

inherited

Definition at line 180 of file ById.h.

typedef int XmlExportable::ExportId

inherited

Definition at line 33 of file XmlExportable.h.

Member Enumeration Documentation

anonymous enum

inherited

Enumerator
NO_ID

Definition at line 28 of file XmlExportable.h.

Constructor & Destructor Documentation

RangeSummarisableTimeValueModel::RangeSummarisableTimeValueModel ( )

inline

Definition at line 37 of file RangeSummarisableTimeValueModel.h.

Member Function Documentation

virtual void RangeSummarisableTimeValueModel::getSummaries	(	int	channel,
		sv_frame_t	start,
		sv_frame_t	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 WritableWaveFileModel, ReadOnlyWaveFileModel, and AggregateWaveModel.

virtual Range RangeSummarisableTimeValueModel::getSummary	(	int	channel,
		sv_frame_t	start,
		sv_frame_t	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 WritableWaveFileModel, ReadOnlyWaveFileModel, and AggregateWaveModel.

virtual int RangeSummarisableTimeValueModel::getSummaryBlockSize ( int desired ) const

pure virtual

Implemented in WritableWaveFileModel, ReadOnlyWaveFileModel, and AggregateWaveModel.

QString RangeSummarisableTimeValueModel::getTypeName ( ) const

inlineoverridevirtual

Return the type of the model.

For display purposes only.

Reimplemented from DenseTimeValueModel.

Reimplemented in WritableWaveFileModel, and ReadOnlyWaveFileModel.

Definition at line 102 of file RangeSummarisableTimeValueModel.h.

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 WritableWaveFileModel, ReadOnlyWaveFileModel, and AggregateWaveModel.

Referenced by DenseTimeValueModel::~DenseTimeValueModel().

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 WritableWaveFileModel, ReadOnlyWaveFileModel, and AggregateWaveModel.

Referenced by DenseTimeValueModel::~DenseTimeValueModel().

virtual int DenseTimeValueModel::getChannelCount ( ) const

pure virtualinherited

Return the number of distinct channels for this model.

Implemented in WritableWaveFileModel, ReadOnlyWaveFileModel, AggregateWaveModel, and WaveFileModel.

Referenced by WavFileWriter::writeModel(), and DenseTimeValueModel::~DenseTimeValueModel().

virtual floatvec_t DenseTimeValueModel::getData	(	int	channel,
		sv_frame_t	start,
		sv_frame_t	count
	)		const

pure virtualinherited

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

Returned vector may have fewer samples than requested, if the end of file was reached.

If the channel is given as -1, mix all available channels and return the result.

Implemented in WritableWaveFileModel, ReadOnlyWaveFileModel, and AggregateWaveModel.

Referenced by WaveformOversampler::getFixedRatioData(), WavFileWriter::writeModel(), and DenseTimeValueModel::~DenseTimeValueModel().

virtual std::vector<floatvec_t> DenseTimeValueModel::getMultiChannelData	(	int	fromchannel,
		int	tochannel,
		sv_frame_t	start,
		sv_frame_t	count
	)		const

pure virtualinherited

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

Returned vector may have fewer samples than requested, if the end of file was reached.

Implemented in WritableWaveFileModel, ReadOnlyWaveFileModel, and AggregateWaveModel.

Referenced by DenseTimeValueModel::~DenseTimeValueModel().

bool DenseTimeValueModel::canPlay ( ) const

inlineoverridevirtualinherited

Reimplemented from Playable.

Definition at line 82 of file DenseTimeValueModel.h.

QString DenseTimeValueModel::getDefaultPlayClipId ( ) const

inlineoverridevirtualinherited

Reimplemented from Playable.

Definition at line 83 of file DenseTimeValueModel.h.

References DenseTimeValueModel::getStringExportHeaders(), and DenseTimeValueModel::toStringExportRows().

QVector< QString > DenseTimeValueModel::getStringExportHeaders ( DataExportOptions options ) const

overridevirtualinherited

Return a label for each column that would be written by toStringExportRows.

Implements Model.

Definition at line 23 of file DenseTimeValueModel.cpp.

Referenced by DenseTimeValueModel::getDefaultPlayClipId().

QVector< QVector< QString > > DenseTimeValueModel::toStringExportRows	(	DataExportOptions	options,
		sv_frame_t	startFrame,
		sv_frame_t	duration
	)		const

overridevirtualinherited

Emit events starting within the given range as string rows ready for conversion to an e.g.

comma-separated data format.

Implements Model.

Definition at line 34 of file DenseTimeValueModel.cpp.

References in_range_for().

Referenced by DenseTimeValueModel::getDefaultPlayClipId().

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 WritableWaveFileModel, NoteModel, SparseTimeValueModel, BoxModel, RegionModel, SparseOneDimensionalModel, FFTModel, ImageModel, TextModel, ReadOnlyWaveFileModel, BasicCompressedDenseThreeDimensionalModel, AggregateWaveModel, Dense3DModelPeakCache, AlignmentModel, and EditableDenseThreeDimensionalModel.

Referenced by Model::isReady(), and CSVFileReader::load().

virtual sv_frame_t Model::getStartFrame ( ) const

pure virtualinherited

Return the first audio frame spanned by the model.

Implemented in WritableWaveFileModel, NoteModel, SparseTimeValueModel, BoxModel, RegionModel, ReadOnlyWaveFileModel, FFTModel, SparseOneDimensionalModel, AggregateWaveModel, ImageModel, TextModel, BasicCompressedDenseThreeDimensionalModel, Dense3DModelPeakCache, AlignmentModel, EditableDenseThreeDimensionalModel, and WaveFileModel.

Referenced by DenseThreeDimensionalModel::getData(), DenseThreeDimensionalModel::getFrameForRow(), DenseThreeDimensionalModel::getRowForFrame(), Model::toXml(), CSVFileWriter::write(), CSVStreamWriter::writeInChunks(), and WavFileWriter::writeModel().

sv_frame_t Model::getEndFrame ( ) const

inlineinherited

Return the audio frame at the end of the model, i.e.

the final frame contained within the model plus 1 (rounded up to the model's "resolution" granularity, if more than 1). The end frame minus the start frame should yield the total duration in frames (as a multiple of the resolution) spanned by the model. This is broadly consistent with the definition of the end frame of a Selection object.

If the end has been extended by extendEndFrame() beyond the true end frame, return the extended end instead. This is usually the behaviour you want.

Definition at line 87 of file Model.h.

References Model::getTrueEndFrame(), and Model::m_extendTo.

Referenced by Model::alignFromReference(), ReadOnlyWaveFileModel::cacheFilled(), WaveformOversampler::getFixedRatioData(), SparseOneDimensionalModel::getNotes(), NoteModel::getNotes(), ReadOnlyWaveFileModel::isReady(), Model::toXml(), CSVFileWriter::write(), CSVStreamWriter::writeInChunks(), and WavFileWriter::writeModel().

virtual sv_frame_t Model::getTrueEndFrame ( ) const

pure virtualinherited

Return the audio frame at the end of the model.

This is identical to getEndFrame(), except that it ignores any extended duration set with extendEndFrame().

Implemented in WritableWaveFileModel, NoteModel, SparseTimeValueModel, BoxModel, RegionModel, ReadOnlyWaveFileModel, FFTModel, SparseOneDimensionalModel, ImageModel, AggregateWaveModel, TextModel, Dense3DModelPeakCache, BasicCompressedDenseThreeDimensionalModel, AlignmentModel, EditableDenseThreeDimensionalModel, and WaveFileModel.

Referenced by Model::getEndFrame().

void Model::extendEndFrame ( sv_frame_t to )

inlineinherited

Extend the end of the model.

If this is set to something beyond the true end of the data within the model, then getEndFrame() will return this value instead of the true end. (This is used by the Tony application.)

Definition at line 109 of file Model.h.

References Model::getSampleRate(), and Model::m_extendTo.

virtual sv_samplerate_t Model::getSampleRate ( ) const

pure virtualinherited

Return the frame rate in frames per second.

Implemented in WritableWaveFileModel, NoteModel, SparseTimeValueModel, BoxModel, RegionModel, SparseOneDimensionalModel, FFTModel, ImageModel, TextModel, ReadOnlyWaveFileModel, AggregateWaveModel, BasicCompressedDenseThreeDimensionalModel, AlignmentModel, Dense3DModelPeakCache, EditableDenseThreeDimensionalModel, and WaveFileModel.

Referenced by Model::extendEndFrame(), DenseThreeDimensionalModel::getData(), Model::getNativeRate(), Model::toXml(), and RDFExporter::write().

virtual sv_samplerate_t Model::getNativeRate ( ) const

inlinevirtualinherited

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

Reimplemented in WritableWaveFileModel, ReadOnlyWaveFileModel, and WaveFileModel.

Definition at line 122 of file Model.h.

References Model::getLocation(), Model::getMaker(), Model::getSampleRate(), Model::getTitle(), and Model::getTypeName().

QString Model::getTitle ( ) const

virtualinherited

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

Reimplemented in WritableWaveFileModel, ReadOnlyWaveFileModel, and WaveFileModel.

Definition at line 177 of file Model.cpp.

References TypedById< Item, Id >::get(), Model::m_mutex, and Model::m_sourceModel.

Referenced by Model::getNativeRate().

QString Model::getMaker ( ) const

virtualinherited

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

Reimplemented in WritableWaveFileModel, ReadOnlyWaveFileModel, and WaveFileModel.

Definition at line 186 of file Model.cpp.

References TypedById< Item, Id >::get(), Model::m_mutex, and Model::m_sourceModel.

Referenced by Model::getNativeRate().

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 WritableWaveFileModel, ReadOnlyWaveFileModel, and WaveFileModel.

Definition at line 195 of file Model.cpp.

References TypedById< Item, Id >::get(), Model::m_mutex, and Model::m_sourceModel.

Referenced by Model::getNativeRate().

virtual bool Model::isSparse ( ) const

inlinevirtualinherited

Return true if this is a sparse model.

Reimplemented in NoteModel, SparseTimeValueModel, BoxModel, RegionModel, SparseOneDimensionalModel, ImageModel, and TextModel.

Definition at line 149 of file Model.h.

Referenced by CSVFileWriter::writeSelection().

virtual bool Model::isReady ( int * cp = nullptr ) 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.

If "completion" is non-NULL, return through it an estimated percentage value showing how far through the background operation it thinks it is (for progress reporting). This should be identical to the value returned by getCompletion().

A model that carries out all its calculation from the constructor or accessor functions would typically return true (and completion == 100) as long as isOK() is true. Other models may make the return value here depend on the internal completion status.

See also isReady().

Implemented in WritableWaveFileModel, NoteModel, DenseThreeDimensionalModel, SparseTimeValueModel, Dense3DModelPeakCache, RegionModel, BoxModel, SparseOneDimensionalModel, ImageModel, TextModel, FFTModel, ReadOnlyWaveFileModel, AlignmentModel, BasicCompressedDenseThreeDimensionalModel, AggregateWaveModel, and EditableDenseThreeDimensionalModel.

Referenced by Model::isReady().

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

Definition at line 196 of file Model.h.

virtual ModelId Model::getSourceModel ( ) const

inlinevirtualinherited

If this model was derived from another, return the id of 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 207 of file Model.h.

References Model::alignFromReference(), Model::alignToReference(), Model::getAlignment(), Model::getAlignmentCompletion(), Model::getAlignmentReference(), Model::m_sourceModel, Model::setAlignment(), and Model::setSourceModel().

void Model::setSourceModel ( ModelId model )

virtualinherited

Set the source model for this model.

Definition at line 31 of file Model.cpp.

References Model::alignmentCompletionChanged(), TypedById< Item, Id >::get(), Model::m_mutex, and Model::m_sourceModel.

Referenced by RDFImporterImpl::getDataModelsSparse(), and Model::getSourceModel().

void Model::setAlignment ( ModelId alignmentModel )

virtualinherited

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

The alignment model, of type AlignmentModel, records both the reference and the alignment.

Definition at line 45 of file Model.cpp.

References Model::alignmentModelCompletionChanged(), Model::completionChanged(), TypedById< Item, Id >::get(), Model::m_alignmentModel, Model::m_mutex, and SVDEBUG.

Referenced by Model::getSourceModel().

const ModelId 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 72 of file Model.cpp.

References Model::m_alignmentModel, and Model::m_mutex.

Referenced by Model::getSourceModel().

const ModelId Model::getAlignmentReference ( ) const

virtualinherited

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

Definition at line 79 of file Model.cpp.

References Model::m_alignmentModel, and Model::m_mutex.

Referenced by Model::getSourceModel().

sv_frame_t Model::alignToReference ( sv_frame_t frame ) const

virtualinherited

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

Definition at line 88 of file Model.cpp.

References TypedById< Item, Id >::get(), Model::m_alignmentModel, Model::m_mutex, and Model::m_sourceModel.

Referenced by Model::getSourceModel().

sv_frame_t Model::alignFromReference ( sv_frame_t referenceFrame ) const

virtualinherited

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

Definition at line 116 of file Model.cpp.

References TypedById< Item, Id >::get(), Model::getEndFrame(), Model::m_alignmentModel, Model::m_mutex, and Model::m_sourceModel.

Referenced by Model::getSourceModel().

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 141 of file Model.cpp.

References TypedById< Item, Id >::get(), Model::m_alignmentModel, Model::m_mutex, Model::m_sourceModel, and SVCERR.

Referenced by Model::getSourceModel().

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 264 of file Model.h.

References Model::m_typeUri.

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

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 271 of file Model.h.

References Model::alignmentCompletionChanged(), Model::alignmentModelCompletionChanged(), Model::completionChanged(), Model::getStringExportHeaders(), Model::m_typeUri, Model::modelChanged(), Model::modelChangedWithin(), Model::ready(), Model::toStringExportRows(), and Model::toXml().

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

overridevirtualinherited

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

Implements XmlExportable.

Reimplemented in NoteModel, SparseTimeValueModel, RegionModel, SparseOneDimensionalModel, TextModel, WritableWaveFileModel, and ReadOnlyWaveFileModel.

Definition at line 204 of file Model.cpp.

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

Referenced by Model::getRDFTypeURI(), AlignmentModel::toXml(), AggregateWaveModel::toXml(), ReadOnlyWaveFileModel::toXml(), EditableDenseThreeDimensionalModel::toXml(), BasicCompressedDenseThreeDimensionalModel::toXml(), WritableWaveFileModel::toXml(), ImageModel::toXml(), TextModel::toXml(), SparseOneDimensionalModel::toXml(), RegionModel::toXml(), BoxModel::toXml(), SparseTimeValueModel::toXml(), and NoteModel::toXml().

void Model::modelChanged ( ModelId myId )

signalinherited

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

void Model::modelChangedWithin	(	ModelId	myId,
		sv_frame_t	startFrame,
		sv_frame_t	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 AggregateWaveModel::AggregateWaveModel(), ReadOnlyWaveFileModel::cacheFilled(), AggregateWaveModel::componentModelChangedWithin(), WritableWaveFileModel::componentModelChangedWithin(), FFTModel::FFTModel(), ReadOnlyWaveFileModel::fillTimerTimedOut(), Model::getRDFTypeURI(), WritableWaveFileModel::init(), DeferredNotifier::makeDeferredNotifications(), ImageModel::remove(), TextModel::remove(), SparseOneDimensionalModel::remove(), BoxModel::remove(), RegionModel::remove(), SparseTimeValueModel::remove(), NoteModel::remove(), EditableDenseThreeDimensionalModel::setColumn(), BasicCompressedDenseThreeDimensionalModel::setColumn(), EditableDenseThreeDimensionalModel::setCompletion(), BasicCompressedDenseThreeDimensionalModel::setCompletion(), AlignmentModel::setPathFrom(), and DeferredNotifier::update().

void Model::completionChanged ( ModelId myId )

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 AggregateWaveModel::AggregateWaveModel(), AggregateWaveModel::componentModelCompletionChanged(), Model::getRDFTypeURI(), Model::setAlignment(), EditableDenseThreeDimensionalModel::setCompletion(), BasicCompressedDenseThreeDimensionalModel::setCompletion(), TextModel::setCompletion(), ImageModel::setCompletion(), SparseOneDimensionalModel::setCompletion(), BoxModel::setCompletion(), RegionModel::setCompletion(), SparseTimeValueModel::setCompletion(), and NoteModel::setCompletion().

void Model::ready ( ModelId myId )

signalinherited

Emitted when internal processing is complete (i.e.

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

Referenced by ReadOnlyWaveFileModel::cacheFilled(), Model::getRDFTypeURI(), AggregateWaveModel::isReady(), and ReadOnlyWaveFileModel::isReady().

void Model::alignmentCompletionChanged ( ModelId myId )

signalinherited

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

(The ModelId provided is that of this model, not the alignment model.)

Referenced by Model::alignmentModelCompletionChanged(), Model::getRDFTypeURI(), and Model::setSourceModel().

Id WithTypedId< Model >::getId ( ) const

inlineprotectedinherited

Return an id for this object.

The id is a unique value for this object among all objects that implement WithId within this single run of the application.

Definition at line 193 of file ById.h.

References TypedId< T >::untyped.

Referenced by BoxModel::add(), RegionModel::add(), SparseTimeValueModel::add(), NoteModel::add(), Model::alignmentModelCompletionChanged(), ReadOnlyWaveFileModel::cacheFilled(), AggregateWaveModel::componentModelChanged(), WritableWaveFileModel::componentModelChanged(), AggregateWaveModel::componentModelChangedWithin(), WritableWaveFileModel::componentModelChangedWithin(), AggregateWaveModel::componentModelCompletionChanged(), ReadOnlyWaveFileModel::fillTimerTimedOut(), ImageModel::getInsertRowCommand(), TextModel::getInsertRowCommand(), SparseOneDimensionalModel::getInsertRowCommand(), RegionModel::getInsertRowCommand(), BoxModel::getInsertRowCommand(), SparseTimeValueModel::getInsertRowCommand(), NoteModel::getInsertRowCommand(), ImageModel::getRemoveRowCommand(), TextModel::getRemoveRowCommand(), SparseOneDimensionalModel::getRemoveRowCommand(), RegionModel::getRemoveRowCommand(), BoxModel::getRemoveRowCommand(), SparseTimeValueModel::getRemoveRowCommand(), NoteModel::getRemoveRowCommand(), ImageModel::getSetDataCommand(), TextModel::getSetDataCommand(), SparseOneDimensionalModel::getSetDataCommand(), RegionModel::getSetDataCommand(), BoxModel::getSetDataCommand(), SparseTimeValueModel::getSetDataCommand(), NoteModel::getSetDataCommand(), WritableWaveFileModel::init(), NoteModel::NoteModel(), AlignmentModel::pathSourceCompletionChanged(), ReadOnlyWaveFileModel::ReadOnlyWaveFileModel(), ImageModel::remove(), TextModel::remove(), SparseOneDimensionalModel::remove(), BoxModel::remove(), RegionModel::remove(), SparseTimeValueModel::remove(), NoteModel::remove(), EditableDenseThreeDimensionalModel::setBinName(), BasicCompressedDenseThreeDimensionalModel::setBinName(), EditableDenseThreeDimensionalModel::setBinNames(), BasicCompressedDenseThreeDimensionalModel::setBinNames(), EditableDenseThreeDimensionalModel::setColumn(), BasicCompressedDenseThreeDimensionalModel::setColumn(), EditableDenseThreeDimensionalModel::setCompletion(), BasicCompressedDenseThreeDimensionalModel::setCompletion(), AlignmentModel::setCompletion(), TextModel::setCompletion(), ImageModel::setCompletion(), SparseOneDimensionalModel::setCompletion(), BoxModel::setCompletion(), RegionModel::setCompletion(), SparseTimeValueModel::setCompletion(), NoteModel::setCompletion(), SparseOneDimensionalModel::SparseOneDimensionalModel(), SparseTimeValueModel::SparseTimeValueModel(), WritableWaveFileModel::writeComplete(), Model::~Model(), NoteModel::~NoteModel(), ReadOnlyWaveFileModel::~ReadOnlyWaveFileModel(), SparseOneDimensionalModel::~SparseOneDimensionalModel(), SparseTimeValueModel::~SparseTimeValueModel(), and WritableWaveFileModel::~WritableWaveFileModel().

int WithId::getUntypedId ( ) const

inlineprotectedinherited

Return an id for this object.

The id is a unique number for this object among all objects that implement WithId within this single run of the application.

Definition at line 168 of file ById.h.

int XmlExportable::getExportId ( ) const

inherited

Return the numerical export identifier for this object.

It's allocated the first time this is called, so objects on which this is never called do not get allocated one.

Definition at line 71 of file XmlExportable.cpp.

References XmlExportable::m_exportId, and mutex.

Referenced by EditableDenseThreeDimensionalModel::toXml(), BasicCompressedDenseThreeDimensionalModel::toXml(), EventSeries::toXml(), ImageModel::toXml(), TextModel::toXml(), Model::toXml(), SparseOneDimensionalModel::toXml(), RegionModel::toXml(), BoxModel::toXml(), SparseTimeValueModel::toXml(), NoteModel::toXml(), and XmlExportable::~XmlExportable().

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(), RDFTransformFactoryImpl::getTransforms(), and XmlExportable::~XmlExportable().

QString XmlExportable::encodeEntities ( QString s )

staticinherited

Definition at line 41 of file XmlExportable.cpp.

Referenced by TextMatcher::test(), PluginXml::toXml(), ReadOnlyWaveFileModel::toXml(), Transform::toXml(), WritableWaveFileModel::toXml(), Model::toXml(), Event::toXml(), RegionModel::toXml(), BoxModel::toXml(), SparseTimeValueModel::toXml(), NoteModel::toXml(), and XmlExportable::~XmlExportable().

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

staticinherited

Definition at line 54 of file XmlExportable.cpp.

Referenced by XmlExportable::~XmlExportable().

virtual bool Playable::getDefaultPlayAudible ( ) const

inlinevirtualinherited

Reimplemented in SparseTimeValueModel.

Definition at line 28 of file Playable.h.

Referenced by PlayParameterRepository::addPlayable().

Member Data Documentation

QMutex Model::m_mutex

mutableprotectedinherited

Definition at line 337 of file Model.h.

Referenced by Model::alignFromReference(), Model::alignToReference(), Model::getAlignment(), Model::getAlignmentCompletion(), Model::getAlignmentReference(), Model::getLocation(), Model::getMaker(), SparseTimeValueModel::getScaleUnits(), NoteModel::getScaleUnits(), NoteModel::getStartFrame(), Model::getTitle(), NoteModel::getTrueEndFrame(), Model::setAlignment(), SparseTimeValueModel::setScaleUnits(), NoteModel::setScaleUnits(), and Model::setSourceModel().

ModelId Model::m_sourceModel

protectedinherited

Definition at line 338 of file Model.h.

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

ModelId Model::m_alignmentModel

protectedinherited

Definition at line 339 of file Model.h.

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

QString Model::m_typeUri

protectedinherited

Definition at line 340 of file Model.h.

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

std::atomic<sv_frame_t> Model::m_extendTo

protectedinherited

Definition at line 341 of file Model.h.

Referenced by Model::extendEndFrame(), and Model::getEndFrame().

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

RangeSummarisableTimeValueModel.h

SV Libraries »

SV Core Library

Classes

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation