DenseThreeDimensionalModel Class Reference

#include <DenseThreeDimensionalModel.h>

Inherits Model.

Inherited by EditableDenseThreeDimensionalModel, and FFTModel.

Inheritance diagram for DenseThreeDimensionalModel:

Inheritance graph
[legend]
Collaboration diagram for DenseThreeDimensionalModel:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 25 of file DenseThreeDimensionalModel.h.

Public Types

typedef std::vector< float > Column

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).
void modelChanged (size_t startFrame, size_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).
void completionChanged ()
 Emitted when some internal processing has advanced a stage, but the model has not changed externally.
void alignmentCompletionChanged ()
 Emitted when the completion percentage changes for the calculation of this model's alignment model.
void aboutToBeDeleted ()
 Emitted when something notifies this model (through calling aboutToDelete() that it is about to delete it.

Public Member Functions

virtual size_t getResolution () const=0
 Return the number of sample frames covered by each column of bins.
virtual size_t getWidth () const=0
 Return the number of columns of bins in the model.
virtual size_t getHeight () const=0
 Return the number of bins in each column.
virtual float getMinimumLevel () const=0
 Return the minimum permissible value in each bin.
virtual float getMaximumLevel () const=0
 Return the maximum permissible value in each bin.
virtual bool isColumnAvailable (size_t column) const =0
 Return true if there are data available for the given column.
virtual void getColumn (size_t column, Column &result) const =0
 Get data from the given column of bin values.
virtual float getValueAt (size_t column, size_t n) const=0
 Get the single data point from the n'th bin of the given column.
virtual QString getBinName (size_t n) const=0
 Get the name of a given bin (i.e.
bool isLocalPeak (size_t x, size_t y)
 Utility function to query whether a given bin is greater than its (vertical) neighbours.
bool isOverThreshold (size_t x, size_t y, float threshold)
 Utility function to query whether a given bin is greater than a certain threshold.
QString getTypeName () const
 Return the type of the model.
virtual int getCompletion () const=0
virtual bool isOK () const=0
 Return true if the model was constructed successfully.
virtual size_t getStartFrame () const=0
 Return the first audio frame spanned by the model.
virtual size_t getEndFrame () const=0
 Return the last audio frame spanned by the model.
virtual size_t getSampleRate () const=0
 Return the frame rate in frames per second.
virtual size_t getNativeRate () const
 Return the frame rate of the underlying material, if the model itself has already been resampled.
virtual QString getTitle () const
 Return the "work title" of the model, if known.
virtual QString getMaker () const
 Return the "artist" or "maker" of the model, if known.
virtual QString getLocation () const
 Return the location of the data in this model (e.g.
virtual Modelclone () const=0
 Return a copy of this model.
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.
virtual const ZoomConstraintgetZoomConstraint () const
 If this model imposes a zoom constraint, i.e.
virtual ModelgetSourceModel () const
 If this model was derived from another, return the model it was derived from.
virtual void setSourceModel (Model *model)
 Set the source model for this model.
virtual void setAlignment (AlignmentModel *alignment)
 Specify an aligment between this model's timeline and that of a reference model.
virtual const ModelgetAlignmentReference () const
 Return the reference model for the current alignment timeline, if any.
virtual size_t alignToReference (size_t frame) const
 Return the frame number of the reference model that corresponds to the given frame number in this model.
virtual size_t alignFromReference (size_t referenceFrame) const
 Return the frame number in this model that corresponds to the given frame number of the reference model.
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.
virtual void toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
 Stream this exportable object out to XML on a text stream.
virtual QString toDelimitedDataString (QString) const
virtual QString toXmlString (QString indent="", QString extraAttributes="") const
 Convert this exportable object to XML in a string.

Static Public Member Functions

static QString encodeEntities (QString)
static QString encodeColour (QColor)
static int getObjectExportId (const void *)

Static Public Attributes

static const int COMPLETION_UNKNOWN

Protected Member Functions

 DenseThreeDimensionalModel ()

Protected Attributes

Modelm_sourceModel
AlignmentModelm_alignment
bool m_aboutToDelete


Member Typedef Documentation

typedef std::vector<float> DenseThreeDimensionalModel::Column

Definition at line 64 of file DenseThreeDimensionalModel.h.


Constructor & Destructor Documentation

DenseThreeDimensionalModel::DenseThreeDimensionalModel (  )  [inline, protected]

Definition at line 106 of file DenseThreeDimensionalModel.h.


Member Function Documentation

virtual size_t DenseThreeDimensionalModel::getResolution (  )  const [pure virtual]

Return the number of sample frames covered by each column of bins.

Implemented in EditableDenseThreeDimensionalModel, and FFTModel.

Referenced by Colour3DPlotLayer::fillCache(), SpectrumLayer::getFeatureDescription(), Colour3DPlotLayer::getFeatureDescription(), SliceLayer::paint(), Colour3DPlotLayer::paint(), Colour3DPlotLayer::paintDense(), and Colour3DPlotLayer::snapToFeatureFrame().

virtual size_t DenseThreeDimensionalModel::getWidth (  )  const [pure virtual]

Return the number of columns of bins in the model.

Implemented in EditableDenseThreeDimensionalModel, and FFTModel.

virtual size_t DenseThreeDimensionalModel::getHeight (  )  const [pure virtual]

Return the number of bins in each column.

Implemented in EditableDenseThreeDimensionalModel, and FFTModel.

Referenced by Colour3DPlotLayer::fillCache(), SliceLayer::getFeatureDescription(), Colour3DPlotLayer::getFeatureDescription(), Colour3DPlotLayer::getVerticalScaleWidth(), isLocalPeak(), SliceLayer::paint(), Colour3DPlotLayer::paint(), Colour3DPlotLayer::paintDense(), and Colour3DPlotLayer::paintVerticalScale().

virtual float DenseThreeDimensionalModel::getMinimumLevel (  )  const [pure virtual]

Return the minimum permissible value in each bin.

Implemented in EditableDenseThreeDimensionalModel, and FFTModel.

Referenced by Colour3DPlotLayer::fillCache(), and Colour3DPlotLayer::getColumn().

virtual float DenseThreeDimensionalModel::getMaximumLevel (  )  const [pure virtual]

Return the maximum permissible value in each bin.

Implemented in EditableDenseThreeDimensionalModel, and FFTModel.

Referenced by Colour3DPlotLayer::fillCache(), and Colour3DPlotLayer::getColumn().

virtual bool DenseThreeDimensionalModel::isColumnAvailable ( size_t  column  )  const [pure virtual]

Return true if there are data available for the given column.

This should return true only if getColumn(column) would not have to do any substantial work to calculate its return values. If this function returns false, it may still be possible to retrieve the column, but its values may have to be calculated.

Implemented in EditableDenseThreeDimensionalModel, and FFTModel.

virtual void DenseThreeDimensionalModel::getColumn ( size_t  column,
Column result 
) const [pure virtual]

Get data from the given column of bin values.

Referenced by Colour3DPlotLayer::getColumn().

virtual float DenseThreeDimensionalModel::getValueAt ( size_t  column,
size_t  n 
) const [pure virtual]

Get the single data point from the n'th bin of the given column.

Implemented in EditableDenseThreeDimensionalModel, and FFTModel.

Referenced by Colour3DPlotLayer::getFeatureDescription(), isLocalPeak(), isOverThreshold(), SpectrumLayer::paint(), SliceLayer::paint(), and Colour3DPlotLayer::paint().

virtual QString DenseThreeDimensionalModel::getBinName ( size_t  n  )  const [pure virtual]

Get the name of a given bin (i.e.

a label to associate with that bin across all columns).

Implemented in EditableDenseThreeDimensionalModel, and FFTModel.

Referenced by Colour3DPlotLayer::getFeatureDescription(), Colour3DPlotLayer::getVerticalScaleWidth(), and Colour3DPlotLayer::paintVerticalScale().

bool DenseThreeDimensionalModel::isLocalPeak ( size_t  x,
size_t  y 
) [inline]

Utility function to query whether a given bin is greater than its (vertical) neighbours.

Definition at line 86 of file DenseThreeDimensionalModel.h.

References getHeight(), and getValueAt().

Referenced by SpectrogramLayer::getAdjustedYBinSourceRange(), and SpectrogramLayer::paint().

bool DenseThreeDimensionalModel::isOverThreshold ( size_t  x,
size_t  y,
float  threshold 
) [inline]

Utility function to query whether a given bin is greater than a certain threshold.

Definition at line 97 of file DenseThreeDimensionalModel.h.

References getValueAt().

Referenced by SpectrogramLayer::getAdjustedYBinSourceRange(), SpectrumLayer::paint(), and SpectrogramLayer::paint().

QString DenseThreeDimensionalModel::getTypeName (  )  const [inline, virtual]

Return the type of the model.

For display purposes only.

Implements Model.

Reimplemented in EditableDenseThreeDimensionalModel, and FFTModel.

Definition at line 101 of file DenseThreeDimensionalModel.h.

virtual int DenseThreeDimensionalModel::getCompletion (  )  const [pure virtual]

Implemented in EditableDenseThreeDimensionalModel, and FFTModel.

Referenced by Colour3DPlotLayer::getCompletion().

virtual bool Model::isOK (  )  const [pure virtual, inherited]

Return true if the model was constructed successfully.

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

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

Referenced by SpectrogramLayer::getAdjustedYBinSourceRange(), WaveformLayer::getChannelArrangement(), WaveformLayer::getCompletion(), WaveformLayer::getFeatureDescription(), SpectrogramLayer::getFeatureDescription(), SpectrogramLayer::getVerticalScaleWidth(), SpectrogramLayer::getXYBinSourceRange(), Model::isReady(), WaveformLayer::paint(), TimeRulerLayer::paint(), SpectrumLayer::paint(), SpectrogramLayer::paint(), SliceLayer::paint(), Colour3DPlotLayer::paint(), WaveformLayer::paintVerticalScale(), SpectrogramLayer::paintVerticalScale(), WaveformLayer::setModel(), SpectrogramLayer::setModel(), and Colour3DPlotLayer::setModel().

virtual size_t Model::getStartFrame (  )  const [pure virtual, inherited]

Return the first audio frame spanned by the model.

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

Referenced by FFTDataServer::FFTDataServer(), Colour3DPlotLayer::fillCache(), SpectrogramLayer::fillTimerTimedOut(), Colour3DPlotLayer::getFeatureDescription(), WaveformLayer::getNormalizeGain(), AlignmentModel::getStartFrame(), SpectrogramLayer::getXBinRange(), Colour3DPlotLayer::paint(), Colour3DPlotLayer::paintDense(), FFTDataServer::FillThread::run(), Model::toXml(), SpectrogramLayer::updateViewMagnitudes(), WavFileWriter::writeModel(), and MainWindowBase::zoomToFit().

virtual size_t Model::getEndFrame (  )  const [pure virtual, inherited]

Return the last audio frame spanned by the model.

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

Referenced by FeatureExtractionModelTransformer::addFeature(), AudioCallbackPlaySource::addModel(), Model::alignFromReference(), Model::alignToReference(), Pane::drawDurationAndRate(), FFTDataServer::FFTDataServer(), Colour3DPlotLayer::fillCache(), SpectrogramLayer::fillTimerTimedOut(), AlignmentModel::getEndFrame(), FFTDataServer::getFillExtent(), WaveformLayer::getNormalizeGain(), SpectrogramLayer::getXBinRange(), Colour3DPlotLayer::paint(), FFTDataServer::FillThread::run(), MainWindowBase::selectVisible(), Model::toXml(), SpectrogramLayer::updateViewMagnitudes(), WavFileWriter::writeModel(), and MainWindowBase::zoomToFit().

virtual size_t Model::getSampleRate (  )  const [pure virtual, inherited]

Return the frame rate in frames per second.

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

Referenced by AudioGenerator::addModel(), AudioCallbackPlaySource::addModel(), Document::alignModel(), AlignmentModel::constructPath(), AlignmentModel::constructReversePath(), LayerFactory::createEmptyModel(), Pane::drawDurationAndRate(), FFTModel::estimateStableFrequency(), FeatureExtractionModelTransformer::FeatureExtractionModelTransformer(), SpectrogramLayer::getAdjustedYBinSourceRange(), SpectrumLayer::getBinForX(), ModelTransformerFactory::getConfigurationForTransform(), SpectrogramLayer::getCurrentVerticalZoomStep(), SpectrogramLayer::getEffectiveMaxFrequency(), SpectrogramLayer::getEffectiveMinFrequency(), WaveformLayer::getFeatureDescription(), SpectrumLayer::getFeatureDescription(), SliceLayer::getFeatureDescription(), Colour3DPlotLayer::getFeatureDescription(), SpectrumLayer::getFrequencyForX(), TimeRulerLayer::getMajorTickSpacing(), Model::getNativeRate(), SpectrogramLayer::getNewVerticalZoomRangeMapper(), FFTModel::getSampleRate(), AlignmentModel::getSampleRate(), SpectrogramLayer::getValueExtents(), SpectrogramLayer::getVerticalScaleWidth(), SpectrogramLayer::getVerticalZoomSteps(), SpectrogramLayer::getXBinSourceRange(), SpectrumLayer::getXForBin(), SpectrumLayer::getXForFrequency(), Layer::getXScaleValue(), SpectrogramLayer::getYBinRange(), SpectrogramLayer::getYBinSourceRange(), SpectrogramLayer::getZeroPadLevel(), TimeRulerLayer::paint(), SpectrogramLayer::paint(), Colour3DPlotLayer::paint(), SpectrogramLayer::paintCrosshairs(), Colour3DPlotLayer::paintDense(), SpectrogramLayer::paintVerticalScale(), SVFileReader::readDerivation(), RealTimeEffectModelTransformer::RealTimeEffectModelTransformer(), RealTimeEffectModelTransformer::run(), FeatureExtractionModelTransformer::run(), SpectrogramLayer::setDisplayExtents(), SpectrogramLayer::setVerticalZoomStep(), TimeRulerLayer::snapToFeatureFrame(), Model::toXml(), and Document::writeBackwardCompatibleDerivation().

virtual size_t Model::getNativeRate (  )  const [inline, virtual, inherited]

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

Reimplemented in WaveFileModel.

Definition at line 67 of file Model.h.

References Model::getSampleRate().

Referenced by Pane::drawDurationAndRate().

QString Model::getTitle (  )  const [virtual, inherited]

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

Reimplemented in WaveFileModel.

Definition at line 150 of file Model.cpp.

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

Referenced by Pane::drawWorkTitle(), and Model::getTitle().

QString Model::getMaker (  )  const [virtual, inherited]

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

Reimplemented in WaveFileModel.

Definition at line 157 of file Model.cpp.

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

Referenced by ModelDataModel::data(), Pane::drawWorkTitle(), and Model::getMaker().

QString Model::getLocation (  )  const [virtual, inherited]

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

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

Referenced by ModelDataModel::data(), and Model::getLocation().

virtual Model* Model::clone (  )  const [pure virtual, inherited]

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 AggregateWaveModel, AlignmentModel, EditableDenseThreeDimensionalModel, FFTModel, SparseModel< PointType >, WaveFileModel, WritableWaveFileModel, SparseModel< Note >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, and SparseModel< AlignmentModel::PathPoint >.

Referenced by AlignmentModel::clone().

virtual bool Model::isReady ( int *  completion = 0  )  const [inline, virtual, inherited]

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

Definition at line 120 of file Model.h.

References Model::isOK().

Referenced by FFTDataServer::fillColumn(), SpectrogramLayer::getAdjustedYBinSourceRange(), WaveformLayer::getCompletion(), SpectrogramLayer::getXYBinSourceRange(), WaveformLayer::paint(), SpectrumLayer::paint(), SpectrogramLayer::paint(), SliceLayer::paint(), Colour3DPlotLayer::paint(), RealTimeEffectModelTransformer::run(), FFTDataServer::FillThread::run(), and FeatureExtractionModelTransformer::run().

virtual const ZoomConstraint* Model::getZoomConstraint (  )  const [inline, virtual, inherited]

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

Definition at line 132 of file Model.h.

Referenced by WaveformLayer::getZoomConstraint(), and Colour3DPlotLayer::getZoomConstraint().

virtual Model* Model::getSourceModel (  )  const [inline, virtual, inherited]

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

References Model::m_sourceModel.

Referenced by View::checkProgress(), and Pane::paintEvent().

void Model::setSourceModel ( Model model  )  [virtual, inherited]

Set the source model for this model.

Definition at line 49 of file Model.cpp.

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

Referenced by Document::addDerivedModel(), FeatureExtractionModelTransformer::FeatureExtractionModelTransformer(), and FFTModel::FFTModel().

void Model::setAlignment ( AlignmentModel alignment  )  [virtual, inherited]

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

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

Referenced by Document::alignModel().

const Model * Model::getAlignmentReference (  )  const [virtual, inherited]

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

Definition at line 101 of file Model.cpp.

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

Referenced by Layer::alignFromReference(), Document::alignModel(), Layer::alignToReference(), Pane::drawAlignmentStatus(), View::getAligningModel(), and Model::getAlignmentReference().

size_t Model::alignToReference ( size_t  frame  )  const [virtual, inherited]

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

Definition at line 111 of file Model.cpp.

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

Referenced by ViewManager::alignPlaybackFrameToReference(), View::alignToReference(), and Layer::alignToReference().

size_t Model::alignFromReference ( size_t  referenceFrame  )  const [virtual, inherited]

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

Definition at line 124 of file Model.cpp.

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

Referenced by View::alignFromReference(), Layer::alignFromReference(), ViewManager::alignReferenceToPlaybackFrame(), and View::getAlignedPlaybackFrame().

int Model::getAlignmentCompletion (  )  const [virtual, inherited]

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

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

Referenced by View::checkProgress(), and Pane::drawAlignmentStatus().

void Model::toXml ( QTextStream &  stream,
QString  indent = "",
QString  extraAttributes = "" 
) const [virtual, inherited]

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

Implements XmlExportable.

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

Definition at line 171 of file Model.cpp.

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

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

virtual QString Model::toDelimitedDataString ( QString   )  const [inline, virtual, inherited]

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

Definition at line 189 of file Model.h.

Referenced by CSVFileWriter::write().

void Model::aboutToDelete (  )  [slot, inherited]

Definition at line 67 of file Model.cpp.

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

Referenced by Document::releaseModel(), Model::setAlignment(), Document::setMainModel(), SpectrumLayer::setModel(), SpectrumLayer::setupFFT(), Document::~Document(), Model::~Model(), and SpectrumLayer::~SpectrumLayer().

void Model::sourceModelAboutToBeDeleted (  )  [slot, inherited]

Reimplemented in FFTModel.

Definition at line 83 of file Model.cpp.

References Model::m_sourceModel.

Referenced by Model::setSourceModel().

void Model::modelChanged (  )  [signal, inherited]

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

Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.

Referenced by SparseValueModel< TimeValuePoint >::addPoint(), SparseModel< PointType >::addPoint(), SparseModel< PointType >::clear(), SparseValueModel< TimeValuePoint >::deletePoint(), SparseModel< PointType >::deletePoint(), EditableDenseThreeDimensionalModel::setBinName(), EditableDenseThreeDimensionalModel::setBinNames(), EditableDenseThreeDimensionalModel::setColumn(), SparseModel< PointType >::setCompletion(), EditableDenseThreeDimensionalModel::setCompletion(), SparseModel< PointType >::setResolution(), and WritableWaveFileModel::WritableWaveFileModel().

void Model::modelChanged ( size_t  startFrame,
size_t  endFrame 
) [signal, inherited]

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

Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.

void Model::completionChanged (  )  [signal, inherited]

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.

Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.

Referenced by Model::setAlignment(), SparseModel< PointType >::setCompletion(), and EditableDenseThreeDimensionalModel::setCompletion().

void Model::alignmentCompletionChanged (  )  [signal, inherited]

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

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

void Model::aboutToBeDeleted (  )  [signal, inherited]

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(), and Model::setSourceModel().

QString XmlExportable::toXmlString ( QString  indent = "",
QString  extraAttributes = "" 
) const [virtual, inherited]

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 LayerFactory::setLayerDefaultProperties().

QString XmlExportable::encodeEntities ( QString   )  [static, inherited]

Definition at line 41 of file XmlExportable.cpp.

Referenced by AudioGenerator::getDefaultPlayPluginConfiguration(), SVFileReader::readPlugin(), Layer::toBriefXml(), WaveFileModel::toXml(), Transform::toXml(), TextPoint::toXml(), PluginXml::toXml(), Model::toXml(), Layer::toXml(), ImagePoint::toXml(), and Document::writeBackwardCompatibleDerivation().

QString XmlExportable::encodeColour ( QColor   )  [static, inherited]

Definition at line 54 of file XmlExportable.cpp.

Referenced by ColourDatabase::getStringValues().

int XmlExportable::getObjectExportId ( const void *   )  [static, inherited]

Definition at line 71 of file XmlExportable.cpp.

Referenced by FFTDataServer::generateFileBasename(), View::getTextLabelHeight(), Layer::toBriefXml(), SparseModel< PointType >::toXml(), Model::toXml(), Layer::toXml(), EditableDenseThreeDimensionalModel::toXml(), Document::toXml(), and Document::writeBackwardCompatibleDerivation().


Member Data Documentation

const int Model::COMPLETION_UNKNOWN [static, inherited]

Definition at line 125 of file Model.h.

Model* Model::m_sourceModel [protected, inherited]

Definition at line 239 of file Model.h.

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

AlignmentModel* Model::m_alignment [protected, inherited]

Definition at line 240 of file Model.h.

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

bool Model::m_aboutToDelete [protected, inherited]

Definition at line 241 of file Model.h.

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


The documentation for this class was generated from the following file:
Generated on Wed Feb 20 15:45:32 2008 for SonicVisualiser by  doxygen 1.5.1