Public Types | Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
AlignmentModel Class Reference

#include <AlignmentModel.h>

Inheritance diagram for AlignmentModel:
Inheritance graph
Collaboration diagram for AlignmentModel:
Collaboration graph

Public Types

typedef Id ModelId
 
typedef TypedId< Model > Id
 
enum  { NO_ID = -1 }
 
typedef int ExportId
 

Signals

void completionChanged (ModelId)
 
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 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

 AlignmentModel (ModelId reference, ModelId aligned, ModelId path)
 
 ~AlignmentModel ()
 
bool isOK () const override
 Return true if the model was constructed successfully. More...
 
void setError (QString error)
 
QString getError () const
 
sv_frame_t getStartFrame () const override
 Return the first audio frame spanned by the model. More...
 
sv_frame_t getTrueEndFrame () const override
 Return the audio frame at the end of the model. More...
 
sv_samplerate_t getSampleRate () const override
 Return the frame rate in frames per second. More...
 
bool isReady (int *completion=0) const override
 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...
 
int getCompletion () const override
 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...
 
const ZoomConstraint * getZoomConstraint () const override
 If this model imposes a zoom constraint, i.e. More...
 
QString getTypeName () const override
 Return the type of the model. More...
 
ModelId getReferenceModel () const
 
ModelId getAlignedModel () const
 
void setCompletion (int completion)
 
sv_frame_t toReference (sv_frame_t frame) const
 
sv_frame_t fromReference (sv_frame_t frame) const
 
void setPathFrom (ModelId pathSource)
 
void setPath (const Path &path)
 
void setRelativePitch (int cents)
 Set the calculated pitch relative to a reference. More...
 
int getRelativePitch () const
 Get the value set with setRelativePitch. More...
 
void toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const override
 Stream this exportable object out to XML on a text stream. More...
 
QVector< QString > getStringExportHeaders (DataExportOptions) const override
 Return a label for each column that would be written by toStringExportRows. More...
 
QVector< QVector< QString > > toStringExportRows (DataExportOptions, sv_frame_t, sv_frame_t) const override
 Emit events starting within the given range as string rows ready for conversion to an e.g. More...
 
sv_frame_t getEndFrame () const
 Return the audio frame at the end of the model, i.e. More...
 
void extendEndFrame (sv_frame_t to)
 Extend the end of the model. 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 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...
 
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 canPlay () const
 
virtual QString getDefaultPlayClipId () const
 
virtual bool getDefaultPlayAudible () const
 

Static Public Member Functions

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

Protected Slots

void pathSourceChangedWithin (ModelId, sv_frame_t startFrame, sv_frame_t endFrame)
 
void pathSourceCompletionChanged (ModelId)
 

Protected Member Functions

void constructPath () const
 
void constructReversePath () const
 
sv_frame_t performAlignment (const Path &path, sv_frame_t frame) const
 
Id getId () const
 Return an id for this object. More...
 
int getUntypedId () const
 Return an id for this object. More...
 

Protected Attributes

ModelId m_reference
 
ModelId m_aligned
 
ModelId m_pathSource
 
std::unique_ptr< Path > m_path
 
std::unique_ptr< Path > m_reversePath
 
bool m_pathBegun
 
bool m_pathComplete
 
QString m_error
 
int m_relativePitch
 
int m_explicitlySetCompletion
 
QMutex m_mutex
 
ModelId m_sourceModel
 
ModelId m_alignmentModel
 
QString m_typeUri
 
std::atomic< sv_frame_t > m_extendTo
 

Detailed Description

Definition at line 28 of file AlignmentModel.h.

Member Typedef Documentation

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

AlignmentModel::AlignmentModel ( ModelId  reference,
ModelId  aligned,
ModelId  path 
)

Definition at line 22 of file AlignmentModel.cpp.

References m_aligned, m_pathComplete, m_reference, and setPathFrom().

AlignmentModel::~AlignmentModel ( )

Definition at line 45 of file AlignmentModel.cpp.

References SVCERR.

Member Function Documentation

bool AlignmentModel::isOK ( ) const
overridevirtual

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 53 of file AlignmentModel.cpp.

References TypedId< T >::isNone(), m_error, and m_pathSource.

void AlignmentModel::setError ( QString  error)
inline

Definition at line 40 of file AlignmentModel.h.

References m_error.

QString AlignmentModel::getError ( ) const
inline

Definition at line 41 of file AlignmentModel.h.

References getSampleRate(), getStartFrame(), getTrueEndFrame(), isReady(), and m_error.

sv_frame_t AlignmentModel::getStartFrame ( ) const
overridevirtual

Return the first audio frame spanned by the model.

Implements Model.

Definition at line 66 of file AlignmentModel.cpp.

References TypedById< Item, Id >::get(), m_aligned, and m_reference.

Referenced by getError().

sv_frame_t AlignmentModel::getTrueEndFrame ( ) const
overridevirtual

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

Implements Model.

Definition at line 81 of file AlignmentModel.cpp.

References TypedById< Item, Id >::get(), m_aligned, and m_reference.

Referenced by getError().

sv_samplerate_t AlignmentModel::getSampleRate ( ) const
overridevirtual

Return the frame rate in frames per second.

Implements Model.

Definition at line 96 of file AlignmentModel.cpp.

References TypedById< Item, Id >::get(), and m_reference.

Referenced by getError().

bool AlignmentModel::isReady ( int *  cp = 0) const
overridevirtual

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

Reimplemented from Model.

Definition at line 107 of file AlignmentModel.cpp.

References TypedId< T >::isNone(), m_explicitlySetCompletion, m_pathBegun, m_pathComplete, m_pathSource, and SVCERR.

Referenced by getCompletion(), and getError().

int AlignmentModel::getCompletion ( ) const
inlineoverridevirtual

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.

Must return 100 when the model is complete.

A model that carries out all its calculation from the constructor or accessor functions might return 0 if isOK() is false and 100 if isOK() is true. Other models may make the return value here depend on the internal completion status.

See also isReady().

Implements Model.

Definition at line 47 of file AlignmentModel.h.

References getZoomConstraint(), and isReady().

const ZoomConstraint * AlignmentModel::getZoomConstraint ( ) const
overridevirtual

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 147 of file AlignmentModel.cpp.

Referenced by getCompletion().

QString AlignmentModel::getTypeName ( ) const
inlineoverridevirtual

Return the type of the model.

For display purposes only.

Implements Model.

Definition at line 54 of file AlignmentModel.h.

References fromReference(), getAlignedModel(), getReferenceModel(), setCompletion(), setPath(), setPathFrom(), and toReference().

ModelId AlignmentModel::getReferenceModel ( ) const

Definition at line 153 of file AlignmentModel.cpp.

References m_reference.

Referenced by getTypeName().

ModelId AlignmentModel::getAlignedModel ( ) const

Definition at line 159 of file AlignmentModel.cpp.

References m_aligned.

Referenced by getTypeName().

void AlignmentModel::setCompletion ( int  completion)

Definition at line 165 of file AlignmentModel.cpp.

References completionChanged(), WithTypedId< Model >::getId(), and m_explicitlySetCompletion.

Referenced by getTypeName().

sv_frame_t AlignmentModel::toReference ( sv_frame_t  frame) const

Definition at line 172 of file AlignmentModel.cpp.

References constructPath(), TypedId< T >::isNone(), m_path, m_pathSource, and performAlignment().

Referenced by getTypeName().

sv_frame_t AlignmentModel::fromReference ( sv_frame_t  frame) const

Definition at line 191 of file AlignmentModel.cpp.

References constructReversePath(), TypedId< T >::isNone(), m_pathSource, m_reversePath, and performAlignment().

Referenced by getTypeName().

void AlignmentModel::setPathFrom ( ModelId  pathSource)

Definition at line 399 of file AlignmentModel.cpp.

References completionChanged(), constructPath(), constructReversePath(), m_pathSource, Model::modelChangedWithin(), pathSourceChangedWithin(), and pathSourceCompletionChanged().

Referenced by AlignmentModel(), and getTypeName().

void AlignmentModel::setPath ( const Path &  path)

Definition at line 425 of file AlignmentModel.cpp.

References constructReversePath(), m_path, and m_pathComplete.

Referenced by getTypeName().

void AlignmentModel::setRelativePitch ( int  cents)
inline

Set the calculated pitch relative to a reference.

This is purely metadata.

Definition at line 71 of file AlignmentModel.h.

References m_relativePitch.

int AlignmentModel::getRelativePitch ( ) const
inline

Get the value set with setRelativePitch.

Definition at line 76 of file AlignmentModel.h.

References m_relativePitch, and toXml().

void AlignmentModel::toXml ( QTextStream &  stream,
QString  indent = "",
QString  extraAttributes = "" 
) const
overridevirtual

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

Implements XmlExportable.

Definition at line 433 of file AlignmentModel.cpp.

References TypedById< Item, Id >::getExportId(), m_aligned, m_path, m_reference, SVDEBUG, and Model::toXml().

Referenced by getRelativePitch().

QVector<QString> AlignmentModel::getStringExportHeaders ( DataExportOptions  options) const
inlineoverridevirtual

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

Implements Model.

Definition at line 83 of file AlignmentModel.h.

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

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 88 of file AlignmentModel.h.

References completionChanged(), pathSourceChangedWithin(), and pathSourceCompletionChanged().

void AlignmentModel::completionChanged ( ModelId  )
signal

Referenced by pathSourceCompletionChanged(), setCompletion(), setPathFrom(), and toStringExportRows().

void AlignmentModel::pathSourceChangedWithin ( ModelId  ,
sv_frame_t  startFrame,
sv_frame_t  endFrame 
)
protectedslot

Definition at line 210 of file AlignmentModel.cpp.

References constructPath(), constructReversePath(), and m_pathComplete.

Referenced by setPathFrom(), and toStringExportRows().

void AlignmentModel::pathSourceCompletionChanged ( ModelId  )
protectedslot

Definition at line 218 of file AlignmentModel.cpp.

References completionChanged(), constructPath(), constructReversePath(), WithTypedId< Model >::getId(), m_pathBegun, m_pathComplete, m_pathSource, and SVCERR.

Referenced by setPathFrom(), and toStringExportRows().

void AlignmentModel::constructPath ( ) const
protected

Definition at line 253 of file AlignmentModel.cpp.

References TypedById< Item, Id >::get(), m_aligned, m_path, and m_pathSource.

Referenced by pathSourceChangedWithin(), pathSourceCompletionChanged(), setPathFrom(), and toReference().

void AlignmentModel::constructReversePath ( ) const
protected

Definition at line 291 of file AlignmentModel.cpp.

References m_path, and m_reversePath.

Referenced by fromReference(), pathSourceChangedWithin(), pathSourceCompletionChanged(), setPath(), and setPathFrom().

sv_frame_t AlignmentModel::performAlignment ( const Path &  path,
sv_frame_t  frame 
) const
protected

Definition at line 322 of file AlignmentModel.cpp.

References Path::getPoints().

Referenced by fromReference(), and toReference().

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

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

Referenced by BoxModel::add(), RegionModel::add(), SparseTimeValueModel::add(), NoteModel::add(), AggregateWaveModel::AggregateWaveModel(), ReadOnlyWaveFileModel::cacheFilled(), AggregateWaveModel::componentModelChanged(), WritableWaveFileModel::componentModelChanged(), Dense3DModelPeakCache::Dense3DModelPeakCache(), FFTModel::FFTModel(), ReadOnlyWaveFileModel::fillTimerTimedOut(), Model::getRDFTypeURI(), WritableWaveFileModel::init(), EditableDenseThreeDimensionalModel::setBinName(), BasicCompressedDenseThreeDimensionalModel::setBinName(), EditableDenseThreeDimensionalModel::setBinNames(), BasicCompressedDenseThreeDimensionalModel::setBinNames(), EditableDenseThreeDimensionalModel::setColumn(), BasicCompressedDenseThreeDimensionalModel::setColumn(), EditableDenseThreeDimensionalModel::setCompletion(), BasicCompressedDenseThreeDimensionalModel::setCompletion(), TextModel::setCompletion(), ImageModel::setCompletion(), SparseOneDimensionalModel::setCompletion(), BoxModel::setCompletion(), RegionModel::setCompletion(), SparseTimeValueModel::setCompletion(), NoteModel::setCompletion(), and WritableWaveFileModel::writeComplete().

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(), setPathFrom(), and DeferredNotifier::update().

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(), 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(), 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::canPlay ( ) const
inlinevirtualinherited

Reimplemented in NoteModel, SparseTimeValueModel, SparseOneDimensionalModel, and DenseTimeValueModel.

Definition at line 26 of file Playable.h.

virtual QString Playable::getDefaultPlayClipId ( ) const
inlinevirtualinherited

Reimplemented in NoteModel, SparseOneDimensionalModel, and DenseTimeValueModel.

Definition at line 27 of file Playable.h.

Referenced by PlayParameterRepository::addPlayable().

virtual bool Playable::getDefaultPlayAudible ( ) const
inlinevirtualinherited

Reimplemented in SparseTimeValueModel.

Definition at line 28 of file Playable.h.

Referenced by PlayParameterRepository::addPlayable().

Member Data Documentation

ModelId AlignmentModel::m_reference
protected

Definition at line 100 of file AlignmentModel.h.

Referenced by AlignmentModel(), getReferenceModel(), getSampleRate(), getStartFrame(), getTrueEndFrame(), and toXml().

ModelId AlignmentModel::m_aligned
protected

Definition at line 101 of file AlignmentModel.h.

Referenced by AlignmentModel(), constructPath(), getAlignedModel(), getStartFrame(), getTrueEndFrame(), and toXml().

ModelId AlignmentModel::m_pathSource
protected

Definition at line 103 of file AlignmentModel.h.

Referenced by constructPath(), fromReference(), isOK(), isReady(), pathSourceCompletionChanged(), setPathFrom(), and toReference().

std::unique_ptr<Path> AlignmentModel::m_path
mutableprotected

Definition at line 106 of file AlignmentModel.h.

Referenced by constructPath(), constructReversePath(), setPath(), toReference(), and toXml().

std::unique_ptr<Path> AlignmentModel::m_reversePath
mutableprotected

Definition at line 107 of file AlignmentModel.h.

Referenced by constructReversePath(), and fromReference().

bool AlignmentModel::m_pathBegun
protected

Definition at line 108 of file AlignmentModel.h.

Referenced by isReady(), and pathSourceCompletionChanged().

bool AlignmentModel::m_pathComplete
protected

Definition at line 109 of file AlignmentModel.h.

Referenced by AlignmentModel(), isReady(), pathSourceChangedWithin(), pathSourceCompletionChanged(), and setPath().

QString AlignmentModel::m_error
protected

Definition at line 110 of file AlignmentModel.h.

Referenced by getError(), isOK(), and setError().

int AlignmentModel::m_relativePitch
protected

Definition at line 111 of file AlignmentModel.h.

Referenced by getRelativePitch(), and setRelativePitch().

int AlignmentModel::m_explicitlySetCompletion
protected

Definition at line 112 of file AlignmentModel.h.

Referenced by isReady(), and setCompletion().

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 files:
Generated by   doxygen 1.8.11