Kwave::MetaData Class Reference

#include <MetaData.h>

Inheritance diagram for Kwave::MetaData:

Collaboration diagram for Kwave::MetaData:

Classes
class	MetaDataPriv

Public Types
enum	Scope {   None = 0, Signal = (1 << 0), Track = (1 << 1), Range = (1 << 2),   Position = (1 << 3), All = ~0 }
typedef QMap< QString, QVariant >	PropertyList

Public Member Functions
	MetaData ()
	MetaData (const MetaData &other)
	MetaData (Scope scope)
virtual	~MetaData ()
virtual void	clear ()
virtual bool	isNull () const
QString	id () const
Scope	scope () const
void	setScope (Scope scope)
void	setProperty (const QString &p, const QVariant &value)
bool	hasProperty (const QString &p) const
QVariant	property (const QString &p) const
QVariant	operator[] (const QString p) const
QVariant &	property (const QString &p)
QVariant &	operator[] (const QString p)
bool	operator== (const MetaData &other) const
bool	operator!= (const MetaData &other) const
QStringList	keys () const
sample_index_t	firstSample () const
sample_index_t	lastSample () const
QList< unsigned int >	boundTracks () const
virtual void	dump () const

Static Public Member Functions
static QStringList	positionBoundPropertyNames ()

Static Public Attributes
static const QString	STDPROP_TYPE
static const QString	STDPROP_TRACKS
static const QString	STDPROP_START
static const QString	STDPROP_END
static const QString	STDPROP_POS
static const QString	STDPROP_DESCRIPTION

Private Attributes
QSharedDataPointer< MetaDataPriv >	m_data

Detailed Description

Definition at line 37 of file MetaData.h.

Member Typedef Documentation

PropertyList

typedef QMap<QString, QVariant> Kwave::MetaData::PropertyList

List of metadata properties

Definition at line 91 of file MetaData.h.

Member Enumeration Documentation

Scope

enum Kwave::MetaData::Scope

Enumerator
None	no scope
Signal	whole signal
Track	bound to a (list of) tracks, requires the property "STDPROP_TRACKS" with a QVariant::List of track indices encoded as QVariant::UInt
Range	bound to a range of samples, requires the properties "STDPROP_START" and "STDPROP_END" with data type QVariant::ULongLong
Position	bound to a single sample, requires the property "STDPROP_POS" with data type "QVariant::ULongLong"
All	can be used for selecting all the scopes above

Definition at line 58 of file MetaData.h.

        {
            None     = 0,

            Signal   = (1 << 0),

            Track    = (1 << 1),

            Range    = (1 << 2),

            Position = (1 << 3),

            All      = ~0
        } Scope;

Constructor & Destructor Documentation

MetaData() [1/3]

Kwave::MetaData::MetaData

(

)

default constructor, generates a metadata object with a new ID

Definition at line 38 of file MetaData.cpp.

    :m_data(Q_NULLPTR)
{
}

MetaData() [2/3]

Kwave::MetaData::MetaData

(

const MetaData &

other

)

copy constructor

Parameters

other

the other meta data object to copy from

Definition at line 44 of file MetaData.cpp.

    :m_data(other.m_data)
{
}

MetaData() [3/3]

Kwave::MetaData::MetaData ( Scope  scope )

explicit

constructor

Definition at line 50 of file MetaData.cpp.

References setScope().

    :m_data(new MetaDataPriv)
{
    setScope(scope);
}

Here is the call graph for this function:

~MetaData()

Kwave::MetaData::~MetaData ( )

virtual

destructor

Definition at line 57 of file MetaData.cpp.

References m_data.

{
    m_data = Q_NULLPTR;
}

Member Function Documentation

boundTracks()

QList< unsigned int > Kwave::MetaData::boundTracks

(

)

const

Returns a list of tracks a meta data item is bound to

Returns

list of bound tracks or empty list if not bound

Definition at line 225 of file MetaData.cpp.

References hasProperty(), property(), and STDPROP_TRACKS.

Referenced by Kwave::MetaDataList::deleteRange(), Kwave::MetaDataList::merge(), Kwave::MetaDataList::scalePositions(), Kwave::MetaDataList::shiftLeft(), Kwave::MetaDataList::shiftRight(), and Kwave::MetaDataList::split().

{
    QList<unsigned int> tracks;
    if (hasProperty(Kwave::MetaData::STDPROP_TRACKS)) {
        const QList<QVariant> v_track_list =
            property(Kwave::MetaData::STDPROP_TRACKS).toList();
        foreach (const QVariant &v, v_track_list) {
            bool ok = false;
            unsigned int t = v.toUInt(&ok);
            if (ok) tracks += t;
        }
    }
    return tracks;
}

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

void Kwave::MetaData::clear ( )

virtual

removes all properties

Definition at line 63 of file MetaData.cpp.

References m_data.

Referenced by Kwave::MetaDataList::cropByTracks().

{
    if (m_data) m_data->m_properties.clear();
}

Here is the caller graph for this function:

dump()

void Kwave::MetaData::dump ( ) const

virtual

dump all properties to stdout, for debugging

Reimplemented in Kwave::FileInfo.

Definition at line 241 of file MetaData.cpp.

References _, All, DBG, keys(), Kwave::MetaData::MetaDataPriv::m_id_counter, Kwave::MetaData::MetaDataPriv::m_id_lock, Position, property(), Range, and scope().

Referenced by Kwave::MetaDataList::dump().

{
    QString scope_list;
    const Scope s = scope();
    if (s == All)
        scope_list = _("all");
    else {
        if (s & Signal)   scope_list += _(" signal");
        if (s & Track)    scope_list += _(" track");
        if (s & Range)    scope_list += _(" range");
        if (s & Position) scope_list += _(" position");
    }
    qDebug("    scope =%s", DBG(scope_list));
    const QStringList props = keys();
    foreach (const QString &p, props) {
        QVariant prop = property(p);
        const QList<QVariant> v_vals = prop.toList();
        QString value;
        if (!v_vals.isEmpty()) {
            foreach (QVariant v, v_vals)
                value += _("{") + v.toString() + _("'} ");
        } else {
            value += _("'") + prop.toString() + _("'");
        }

        qDebug("    '%s' = %s", DBG(p), DBG(value));
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

firstSample()

sample_index_t Kwave::MetaData::firstSample

(

)

const

Returns the index of the first sample covered by a given meta data item

Returns

index of the first sample

Definition at line 165 of file MetaData.cpp.

References hasProperty(), Position, property(), Range, scope(), STDPROP_POS, and STDPROP_START.

Referenced by Kwave::MetaDataList::deleteRange(), isLessThan(), Kwave::MetaDataList::merge(), Kwave::MetaDataList::scalePositions(), Kwave::MetaDataList::shiftLeft(), Kwave::MetaDataList::shiftRight(), and Kwave::MetaDataList::split().

{
    // single position?
    if ((scope() & Kwave::MetaData::Position) &&
        hasProperty(Kwave::MetaData::STDPROP_POS)) {
        bool ok = false;
        sample_index_t pos =
            property(Kwave::MetaData::STDPROP_POS).toULongLong(&ok);
        if (ok) return pos;
    }

    // start sample index given
    if ((scope() & Kwave::MetaData::Range) &&
        hasProperty(Kwave::MetaData::STDPROP_START)) {
        bool ok = false;
        sample_index_t start = static_cast<sample_index_t>(
            property(Kwave::MetaData::STDPROP_START).toULongLong(&ok));
        if (ok) return start;
    }

    // fallback: start at zero
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

hasProperty()

bool Kwave::MetaData::hasProperty

(

const QString &

p

)

const

Checks whether this metadata object contains a given property.

Parameters

p	name of the property

Returns

true if the property exists, false otherwise

Definition at line 104 of file MetaData.cpp.

References m_data.

Referenced by boundTracks(), Kwave::FileInfo::contains(), Kwave::MetaDataList::cropByTracks(), Kwave::MetaDataList::deleteRange(), Kwave::MetaDataList::deleteTrack(), Kwave::UndoDeleteMetaDataAction::description(), Kwave::UndoModifyMetaDataAction::description(), Kwave::FileInfo::FileInfo(), firstSample(), Kwave::FileInfo::get(), Kwave::MetaDataList::insertTrack(), lastSample(), Kwave::MetaDataList::merge(), Kwave::SampleRatePlugin::run(), Kwave::MetaDataList::scalePositions(), Kwave::MetaDataList::selectByPosition(), Kwave::MetaDataList::selectByProperty(), Kwave::MetaDataList::selectByRange(), Kwave::MetaDataList::selectByTracks(), Kwave::MetaDataList::selectByValue(), Kwave::MetaDataList::shiftLeft(), Kwave::MetaDataList::shiftRight(), Kwave::MetaDataList::split(), and Kwave::UndoAddMetaDataAction::UndoAddMetaDataAction().

{
    return (m_data && m_data->m_properties.contains(property));
}

Here is the caller graph for this function:

id()

QString Kwave::MetaData::id

(

)

const

returns the ID of the meta data

Definition at line 75 of file MetaData.cpp.

References m_data.

Referenced by Kwave::MetaDataList::add(), Kwave::MetaDataList::contains(), Kwave::UndoDeleteMetaDataAction::dump(), Kwave::UndoModifyMetaDataAction::dump(), Kwave::MetaDataList::remove(), Kwave::MetaDataList::selectByTracks(), and Kwave::UndoModifyMetaDataAction::undo().

{
    return (m_data) ? m_data->m_id : QString();
}

Here is the caller graph for this function:

isNull()

bool Kwave::MetaData::isNull ( ) const

virtual

returns true if this is an empty record

Definition at line 69 of file MetaData.cpp.

References m_data.

Referenced by Kwave::MetaDataList::add(), Kwave::MainWidget::addLabel(), Kwave::SignalManager::executeCommand(), Kwave::TrackView::findItem(), Kwave::MainWidget::labelProperties(), Kwave::SignalManager::modifyLabel(), Kwave::Label::moveTo(), Kwave::LabelItem::moveTo(), Kwave::Label::rename(), Kwave::SaveBlocksPlugin::scanBlocksToSave(), Kwave::K3BExportPlugin::scanBlocksToSave(), Kwave::SaveBlocksPlugin::start(), and Kwave::WavEncoder::writeLabels().

{
    return (!m_data || (m_data->m_properties.isEmpty()));
}

Here is the caller graph for this function:

keys()

QStringList Kwave::MetaData::keys

(

)

const

returns a list with all property names

Definition at line 149 of file MetaData.cpp.

References m_data.

Referenced by Kwave::UndoDeleteMetaDataAction::dump(), Kwave::UndoModifyMetaDataAction::dump(), dump(), and Kwave::MetaDataList::merge().

{
    return (m_data) ? m_data->m_properties.keys() : QStringList();
}

Here is the caller graph for this function:

lastSample()

sample_index_t Kwave::MetaData::lastSample

(

)

const

Returns the index of the last sample covered by a given meta data item

Returns

index of the last sample

Definition at line 190 of file MetaData.cpp.

References hasProperty(), Position, property(), Range, SAMPLE_INDEX_MAX, scope(), STDPROP_END, STDPROP_POS, and STDPROP_START.

Referenced by Kwave::MetaDataList::deleteRange(), Kwave::MetaDataList::merge(), Kwave::MetaDataList::scalePositions(), Kwave::MetaDataList::shiftLeft(), Kwave::MetaDataList::shiftRight(), and Kwave::MetaDataList::split().

{
    // single position?
    if ((scope() & Kwave::MetaData::Position) &&
        hasProperty(Kwave::MetaData::STDPROP_POS)) {
        bool ok = false;
        sample_index_t pos =
            property(Kwave::MetaData::STDPROP_POS).toULongLong(&ok);
        if (ok) return pos;
    }

    // bound to a scope
    if (scope() & Kwave::MetaData::Range) {
        // end sample index given
        if (hasProperty(Kwave::MetaData::STDPROP_END)) {
            bool ok = false;
            sample_index_t end = static_cast<sample_index_t>(
                property(Kwave::MetaData::STDPROP_END).toULongLong(&ok));
            if (ok) return end;
        }

        // fallback: no end => use start
        if (hasProperty(Kwave::MetaData::STDPROP_START)) {
            bool ok = false;
            sample_index_t start = static_cast<sample_index_t>(
                property(Kwave::MetaData::STDPROP_START).toULongLong(&ok));
            if (ok) return start;
        }
    }

    // fallback: infinite
    return SAMPLE_INDEX_MAX;
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

bool Kwave::MetaData::operator!= ( const MetaData &  other ) const

inline

not equal operator, compares by data (not by ID)

Definition at line 178 of file MetaData.h.

        {
            return !(operator == (other));
        }

operator==()

bool Kwave::MetaData::operator==

(

const MetaData &

other

)

const

equal operator, compares by data (not by ID)

Definition at line 131 of file MetaData.cpp.

References m_data.

{
    if (!m_data && !other.m_data)
        return true; // both are null objects

    if ((!m_data) ^ (!other.m_data))
        return false; // only one is a null object

    if (m_data->m_scope != other.m_data->m_scope)
        return false; // different scope

    if (m_data->m_properties != other.m_data->m_properties)
        return false; // properties differ

    return true; // no mismatch found
}

operator[]() [1/2]

QVariant Kwave::MetaData::operator[] ( const QString  p ) const

inline

Same as above, for using through the [] operator

Definition at line 155 of file MetaData.h.

        {
            return property(p);
        }

operator[]() [2/2]

QVariant& Kwave::MetaData::operator[] ( const QString  p )

inline

Same as above, for using through the [] operator

Definition at line 169 of file MetaData.h.

        {
            return property(p);
        }

positionBoundPropertyNames()

QStringList Kwave::MetaData::positionBoundPropertyNames ( )

static

returns a list of position bount property names

Definition at line 155 of file MetaData.cpp.

References STDPROP_END, STDPROP_POS, and STDPROP_START.

Referenced by Kwave::MetaDataList::merge(), Kwave::SampleRatePlugin::run(), and Kwave::UndoAddMetaDataAction::UndoAddMetaDataAction().

{
    QStringList list;
    list << Kwave::MetaData::STDPROP_START;
    list << Kwave::MetaData::STDPROP_END;
    list << Kwave::MetaData::STDPROP_POS;
    return list;
}

Here is the caller graph for this function:

property() [1/2]

QVariant Kwave::MetaData::property

(

const QString &

p

)

const

Returns a QVariant with the copy of the value of a property or an empty QVariant if the property does not exist.

Parameters

p	name of the property

Returns

value of the property or an empty QVariant

Definition at line 110 of file MetaData.cpp.

References m_data.

Referenced by boundTracks(), dump(), firstSample(), Kwave::FileInfo::get(), lastSample(), Kwave::Label::name(), and Kwave::Label::pos().

{
    if (m_data && m_data->m_properties.contains(p))
        return m_data->m_properties[p];
    else
        return QVariant();
}

Here is the caller graph for this function:

property() [2/2]

QVariant & Kwave::MetaData::property

(

const QString &

p

)

Returns a mutable reference to an existing property (or the reference to an empty dummy if it did not exist).

Parameters

p	name of the property

Returns

reference to the value of the property

Definition at line 119 of file MetaData.cpp.

References m_data.

{
    if (m_data && m_data->m_properties.contains(p))
        return m_data->m_properties[p];
    else {
        static QVariant dummy;
        dummy.clear();
        return dummy;
    }
}

scope()

Kwave::MetaData::Scope Kwave::MetaData::scope

(

)

const

returns the scope of the meta data

Definition at line 81 of file MetaData.cpp.

References m_data, and None.

Referenced by Kwave::MetaDataList::cropByRange(), Kwave::MetaDataList::cropByTracks(), Kwave::MetaDataList::deleteRange(), dump(), firstSample(), lastSample(), Kwave::MetaDataList::merge(), Kwave::MetaDataList::selectByPosition(), Kwave::MetaDataList::selectByRange(), Kwave::MetaDataList::selectByScope(), and setScope().

{
    return (m_data) ? m_data->m_scope : None;
}

Here is the caller graph for this function:

setProperty()

void Kwave::MetaData::setProperty	(	const QString &	p,
		const QVariant &	value
	)

Sets a property to a new value. If the property already exists it will be created and if it did not exist, a new one will be created. If the value is not valid (null), the property will be deleted.

Parameters

p	name of the property
value	a QVariant with the property's data

Definition at line 93 of file MetaData.cpp.

References m_data.

Referenced by Kwave::MetaDataList::deleteRange(), Kwave::FileInfo::FileInfo(), Kwave::Label::Label(), Kwave::MetaDataList::merge(), Kwave::Label::moveTo(), Kwave::Label::rename(), Kwave::MetaDataList::scalePositions(), Kwave::FileInfo::set(), Kwave::MetaDataList::shiftLeft(), Kwave::MetaDataList::shiftRight(), and Kwave::MetaDataList::split().

{
    if (m_data) {
        if (value.isValid())
            m_data->m_properties[p] = value;
        else
            m_data->m_properties.remove(p);
    }
}

Here is the caller graph for this function:

setScope()

void Kwave::MetaData::setScope

(

Scope

scope

)

Sets the scope of the meta data

Parameters

scope

the new scope

Definition at line 87 of file MetaData.cpp.

References m_data, and scope().

Referenced by MetaData().

{
    if (m_data) m_data->m_scope = scope;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_data

QSharedDataPointer<MetaDataPriv> Kwave::MetaData::m_data

private

pointer to the shared meta data

Definition at line 250 of file MetaData.h.

Referenced by clear(), hasProperty(), id(), isNull(), keys(), operator==(), property(), scope(), setProperty(), setScope(), and ~MetaData().

STDPROP_DESCRIPTION

const QString Kwave::MetaData::STDPROP_DESCRIPTION

static

standard property: description (string)

Definition at line 56 of file MetaData.h.

Referenced by Kwave::Label::Label(), Kwave::Label::name(), and Kwave::Label::rename().

STDPROP_END

const QString Kwave::MetaData::STDPROP_END

static

standard property: end sample index (inclusive)

Definition at line 50 of file MetaData.h.

Referenced by Kwave::MetaDataList::cropByRange(), Kwave::MetaDataList::deleteRange(), lastSample(), Kwave::MetaDataList::merge(), positionBoundPropertyNames(), Kwave::MetaDataList::scalePositions(), Kwave::MetaDataList::selectByRange(), Kwave::MetaDataList::shiftLeft(), Kwave::MetaDataList::shiftRight(), and Kwave::MetaDataList::split().

STDPROP_POS

const QString Kwave::MetaData::STDPROP_POS

static

standard property: position [zero based sample index]

Definition at line 53 of file MetaData.h.

Referenced by Kwave::MetaDataList::cropByRange(), Kwave::MetaDataList::deleteRange(), firstSample(), Kwave::Label::Label(), lastSample(), Kwave::Label::moveTo(), Kwave::Label::pos(), positionBoundPropertyNames(), Kwave::MetaDataList::scalePositions(), Kwave::MetaDataList::selectByPosition(), Kwave::MetaDataList::selectByRange(), Kwave::MetaDataList::shiftLeft(), and Kwave::MetaDataList::shiftRight().

STDPROP_START

const QString Kwave::MetaData::STDPROP_START

static

standard property: start sample index (inclusive)

Definition at line 47 of file MetaData.h.

Referenced by Kwave::MetaDataList::cropByRange(), Kwave::MetaDataList::deleteRange(), firstSample(), lastSample(), Kwave::MetaDataList::merge(), positionBoundPropertyNames(), Kwave::MetaDataList::scalePositions(), Kwave::MetaDataList::selectByRange(), Kwave::MetaDataList::shiftLeft(), Kwave::MetaDataList::shiftRight(), and Kwave::MetaDataList::split().

STDPROP_TRACKS

const QString Kwave::MetaData::STDPROP_TRACKS

static

standard property: list of zero based track indices

Definition at line 44 of file MetaData.h.

Referenced by boundTracks(), Kwave::MetaDataList::cropByTracks(), Kwave::MetaDataList::deleteRange(), Kwave::MetaDataList::deleteTrack(), Kwave::MetaDataList::insertTrack(), Kwave::MetaDataList::merge(), Kwave::MetaDataList::scalePositions(), Kwave::MetaDataList::selectByTracks(), Kwave::MetaDataList::shiftLeft(), Kwave::MetaDataList::shiftRight(), Kwave::MetaDataList::split(), and Kwave::UndoAddMetaDataAction::UndoAddMetaDataAction().

STDPROP_TYPE

const QString Kwave::MetaData::STDPROP_TYPE

static

standard property: type of the meta data object

Definition at line 41 of file MetaData.h.

Referenced by Kwave::UndoDeleteMetaDataAction::description(), Kwave::UndoModifyMetaDataAction::description(), Kwave::FileInfo::FileInfo(), Kwave::Label::Label(), Kwave::MetaDataList::merge(), Kwave::Label::moveTo(), Kwave::Label::rename(), Kwave::MetaDataList::replace(), Kwave::MetaDataList::selectByType(), and Kwave::UndoAddMetaDataAction::UndoAddMetaDataAction().

---

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

• libkwave/MetaData.h
• libkwave/MetaData.cpp