TagLib::ID3v2::PopularimeterFrame Class Reference

An implementation of ID3v2 "popularimeter". More...

#include <popularimeterframe.h>

Inheritance diagram for TagLib::ID3v2::PopularimeterFrame:

[legend]

Collaboration diagram for TagLib::ID3v2::PopularimeterFrame:

[legend]

List of all members.

Public Member Functions
	PopularimeterFrame ()
	PopularimeterFrame (const ByteVector &data)
virtual	~PopularimeterFrame ()
virtual String	toString () const
String	email () const
void	setEmail (const String &email)
int	rating () const
void	setRating (int rating)
uint	counter () const
void	setCounter (uint counter)
Protected Member Functions
virtual void	parseFields (const ByteVector &data)
virtual ByteVector	renderFields () const
Friends
class	FrameFactory

---

Detailed Description

An implementation of ID3v2 "popularimeter".

This implements the ID3v2 popularimeter (POPM frame). It concists of an email, a rating and an optional counter.

---

Constructor & Destructor Documentation

TagLib::ID3v2::PopularimeterFrame::PopularimeterFrame

(

)

[explicit]

Construct an empty popularimeter frame.

TagLib::ID3v2::PopularimeterFrame::PopularimeterFrame

(

const ByteVector &

data

)

[explicit]

Construct a popularimeter based on the data in data.

virtual TagLib::ID3v2::PopularimeterFrame::~PopularimeterFrame

(

)

[virtual]

Destroys this PopularimeterFrame instance.

---

Member Function Documentation

uint TagLib::ID3v2::PopularimeterFrame::counter

(

)

const

Returns the counter.

See also:

setCounter()

String TagLib::ID3v2::PopularimeterFrame::email

(

)

const

Returns the email.

See also:

setEmail()

virtual void TagLib::ID3v2::PopularimeterFrame::parseFields

(

const ByteVector &

data

)

[protected, virtual]

Called by parse() to parse the field data. It makes this information available through the public API. This must be overridden by the subclasses.

Implements TagLib::ID3v2::Frame.

int TagLib::ID3v2::PopularimeterFrame::rating

(

)

const

Returns the rating.

See also:

setRating()

virtual ByteVector TagLib::ID3v2::PopularimeterFrame::renderFields

(

)

const [protected, virtual]

Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.

Implements TagLib::ID3v2::Frame.

void TagLib::ID3v2::PopularimeterFrame::setCounter

(

uint

counter

)

Set the counter.

See also:

counter()

void TagLib::ID3v2::PopularimeterFrame::setEmail

(

const String &

email

)

Set the email.

See also:

email()

void TagLib::ID3v2::PopularimeterFrame::setRating

(

int

rating

)

Set the rating.

See also:

rating()

virtual String TagLib::ID3v2::PopularimeterFrame::toString

(

)

const [virtual]

Returns the text of this popularimeter.

See also:

text()

Implements TagLib::ID3v2::Frame.

---

Friends And Related Function Documentation

friend class FrameFactory [friend]

Reimplemented from TagLib::ID3v2::Frame.

---

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

• popularimeterframe.h