Kwave::LabelList Class Reference

#include <LabelList.h>

Inheritance diagram for Kwave::LabelList:

Collaboration diagram for Kwave::LabelList:

Public Member Functions
	LabelList ()
	LabelList (const Kwave::MetaDataList &meta_data_list)
virtual	~LabelList ()
virtual void	sort ()
Kwave::MetaDataList	toMetaDataList () const
sample_index_t	nextLabelLeft (sample_index_t from)
sample_index_t	nextLabelRight (sample_index_t from)

Detailed Description

not more than a typedef since Qt4

Definition at line 33 of file LabelList.h.

Constructor & Destructor Documentation

LabelList() [1/2]

Kwave::LabelList::LabelList

(

)

Default constructor

Definition at line 28 of file LabelList.cpp.

    :QList<Kwave::Label>()
{
}

LabelList() [2/2]

Kwave::LabelList::LabelList ( const Kwave::MetaDataList &  meta_data_list )

explicit

Constructor, creates a label list from a list of meta data objects, by filtering out all objects of label type (already sorted by position)

Parameters

meta_data_list

list of meta data

Definition at line 34 of file LabelList.cpp.

References Kwave::Label::metaDataType(), Kwave::MetaDataList::selectByType(), sort(), and Kwave::MetaDataList::toSortedList().

    :QList<Kwave::Label>()
{
    if (!meta_data_list.isEmpty()) {
        // get a list sorted by position
        QList<Kwave::MetaData> list =
            meta_data_list.selectByType(Kwave::Label::metaDataType()).toSortedList();

        if (!list.isEmpty()) {
            // append a label for each meta data object
            foreach (const Kwave::MetaData &meta_data, list)
                append(Kwave::Label(meta_data));
        }

        sort();
    }
}

Here is the call graph for this function:

~LabelList()

Kwave::LabelList::~LabelList ( )

virtual

Destructor

Definition at line 53 of file LabelList.cpp.

{
}

Member Function Documentation

nextLabelLeft()

sample_index_t Kwave::LabelList::nextLabelLeft

(

sample_index_t

from

)

returns the position of the next label left from a given position or zero (begin of signal) if there is none

Returns

a sample index [0...length-1]

Definition at line 80 of file LabelList.cpp.

References Kwave::Label::pos().

Referenced by Kwave::PlayerToolBar::toolbarRewindPrev(), and Kwave::PlayerToolBar::updateState().

{
    sample_index_t best  = 0;
    bool           found = false;
    if (!isEmpty()) {
        foreach (const Kwave::Label &label, *this) {
            sample_index_t lp = label.pos();
            if (lp >= from) break;
            best  = lp;
            found = true;
        }
    }
    return (found) ? best : 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nextLabelRight()

sample_index_t Kwave::LabelList::nextLabelRight

(

sample_index_t

from

)

returns the position of the next label right from a given position or SAMPLE_INDEX_MAX if there is none

Returns

a sample index [0...length-1] or SAMPLE_INDEX_MAX

Definition at line 96 of file LabelList.cpp.

References Kwave::Label::pos(), and SAMPLE_INDEX_MAX.

Referenced by Kwave::PlayerToolBar::toolbarForwardNext(), and Kwave::PlayerToolBar::updateState().

{
    if (!isEmpty()) {
        foreach (const Kwave::Label &label, *this) {
            sample_index_t lp = label.pos();
            if (lp  > from)
                return lp; // found the first label after "from"
        }
    }
    // nothing found: return "infinite"
    return SAMPLE_INDEX_MAX;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sort()

void Kwave::LabelList::sort ( )

virtual

sorts the list by ascending position

Definition at line 64 of file LabelList.cpp.

References compare_labels().

Referenced by LabelList(), and Kwave::WavDecoder::open().

{
    if (!isEmpty())
        std::sort(begin(), end(), compare_labels);
}

Here is the call graph for this function:

Here is the caller graph for this function:

toMetaDataList()

Kwave::MetaDataList Kwave::LabelList::toMetaDataList

(

)

const

returns the content of this list as a list of Kwave::MetaData objects

Returns

a meta data list

Definition at line 71 of file LabelList.cpp.

References Kwave::MetaDataList::add().

Referenced by Kwave::AsciiDecoder::open(), and Kwave::WavDecoder::open().

{
    Kwave::MetaDataList list;
    foreach (const Kwave::Label &label, *this)
        list.add(label);
    return list;
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• libkwave/LabelList.h
• libkwave/LabelList.cpp