com::bbc::libmpdpp::ContentPopularityRate Class Reference

#include <libmpd++/ContentPopularityRate.hh>

Classes
class	PR

Public Member Functions
	ContentPopularityRate ()
	ContentPopularityRate (const ContentPopularityRate &to_copy)
	ContentPopularityRate (ContentPopularityRate &&to_move)
virtual	~ContentPopularityRate ()
ContentPopularityRate &	operator= (const ContentPopularityRate &to_copy)
ContentPopularityRate &	operator= (ContentPopularityRate &&to_move)
bool	operator== (const ContentPopularityRate &to_compare) const
const std::list< PR > &	prs () const
ContentPopularityRate &	prsRemove (const PR &pr)
std::list< PR >::const_iterator	cbegin () const
std::list< PR >::const_iterator	begin () const
std::list< PR >::iterator	begin ()
std::list< PR >::const_iterator	prsBegin () const
std::list< PR >::iterator	prsBegin ()
std::list< PR >::const_iterator	cend () const
std::list< PR >::const_iterator	end () const
std::list< PR >::iterator	end ()
std::list< PR >::const_iterator	prsEnd () const
std::list< PR >::iterator	prsEnd ()
ContentPopularityRate &	prs (const std::list< PR > &prs_list)
ContentPopularityRate &	prs (std::list< PR > &&prs_list)
ContentPopularityRate &	prsAdd (const PR &pr)
ContentPopularityRate &	prsAdd (PR &&pr)
ContentPopularityRate &	prsRemove (const std::list< PR >::iterator &it)
ContentPopularityRate &	prsRemove (const std::list< PR >::const_iterator &it)

Detailed Description

ContentPopularityRate class

This is the container for ContentPopularityRate elements from a DASH MPD. This indicates the level of popularity of the containing entity (i.e. the AdaptationSet, Representation or Preselection) within the media presentation.

This follows the DASH MPD XML schema definition in ISO 23009-1:2022 Clause 5.14.3.

Constructor & Destructor Documentation

ContentPopularityRate() [1/3]

com::bbc::libmpdpp::ContentPopularityRate::ContentPopularityRate

(

)

Default constructor

Creates an empty ContentPopularityRate.

ContentPopularityRate() [2/3]

com::bbc::libmpdpp::ContentPopularityRate::ContentPopularityRate

(

const ContentPopularityRate &

to_copy

)

Copy constructor

Creates a new ContentPopularityRate object which is a copy of to_copy.

Parameters

to_copy

The ContentPopularityRate object to copy.

ContentPopularityRate() [3/3]

com::bbc::libmpdpp::ContentPopularityRate::ContentPopularityRate

(

ContentPopularityRate &&

to_move

)

Move constructor

Creates a new ContentPopularityRate object which transfers the resources from to_move.

Parameters

to_move

The ContentPopularityRate object to move.

~ContentPopularityRate()

virtual com::bbc::libmpdpp::ContentPopularityRate::~ContentPopularityRate ( )

inlinevirtual

Destructor

Member Function Documentation

begin() [1/2]

std::list< PR >::iterator com::bbc::libmpdpp::ContentPopularityRate::begin ( )

inline

Get a forward iterator for the start of the PR elements list

Returns

An iterator for the start of the PR elements list

begin() [2/2]

std::list< PR >::const_iterator com::bbc::libmpdpp::ContentPopularityRate::begin ( ) const

inline

Get a forward iterator for the start of the PR elements list

Returns

An iterator for the start of the PR elements list

cbegin()

std::list< PR >::const_iterator com::bbc::libmpdpp::ContentPopularityRate::cbegin ( ) const

inline

Get a forward iterator for the start of the PR elements list

Returns

An iterator for the start of the PR elements list

cend()

std::list< PR >::const_iterator com::bbc::libmpdpp::ContentPopularityRate::cend ( ) const

inline

Get a forward iterator for the end of the PR elements list

Returns

An iterator for the end of the PR elements list

end() [1/2]

std::list< PR >::iterator com::bbc::libmpdpp::ContentPopularityRate::end ( )

inline

Get a forward iterator for the end of the PR elements list

Returns

An iterator for the end of the PR elements list

end() [2/2]

std::list< PR >::const_iterator com::bbc::libmpdpp::ContentPopularityRate::end ( ) const

inline

Get a forward iterator for the end of the PR elements list

Returns

An iterator for the end of the PR elements list

operator=() [1/2]

ContentPopularityRate & com::bbc::libmpdpp::ContentPopularityRate::operator=

(

const ContentPopularityRate &

to_copy

)

Copy operator

Copies the values from to_copy into this ContentPopularityRate object.

Parameters

to_copy

The ContentPopularityRate object to copy.

Returns

This ContentPopularityRate object.

operator=() [2/2]

ContentPopularityRate & com::bbc::libmpdpp::ContentPopularityRate::operator=

(

ContentPopularityRate &&

to_move

)

Move operator

Transfers the resources from to_move into this ContentPopularityRate object.

Parameters

to_move

The ContentPopularityRate object to move.

Returns

This ContentPopularityRate object.

operator==()

bool com::bbc::libmpdpp::ContentPopularityRate::operator==

(

const ContentPopularityRate &

to_compare

)

const

Equality operator

Compare the value of this ContentPopularityRate to to_compare.

Parameters

to_compare

The ContentPopularityRate object to compare this object to.

Returns

true if this ContentPopularityRate object contains the same values as to_compare, otherwise false.

prs() [1/3]

const std::list< PR > & com::bbc::libmpdpp::ContentPopularityRate::prs ( ) const

inline

Get the list of PR child elements

Returns

The list of PR elements.

prs() [2/3]

ContentPopularityRate & com::bbc::libmpdpp::ContentPopularityRate::prs ( const std::list< PR > & prs_list )

inline

Set the PR elements list

Replace the PRs list with prs_list.

Parameters

prs_list

The list to set as the list of PR elements.

Returns

This ContentPopularityRate.

prs() [3/3]

ContentPopularityRate & com::bbc::libmpdpp::ContentPopularityRate::prs ( std::list< PR > && prs_list )

inline

Set the PR elements list

Replace the PRs list with prs_list.

Parameters

prs_list

The list to set as the list of PR elements.

Returns

This ContentPopularityRate.

prsAdd() [1/2]

ContentPopularityRate & com::bbc::libmpdpp::ContentPopularityRate::prsAdd ( const PR & pr )

inline

Add a PR to the list of PRs

Parameters

pr	The PR to add to the end of the list.

Returns

This ContentPopularityRate.

prsAdd() [2/2]

ContentPopularityRate & com::bbc::libmpdpp::ContentPopularityRate::prsAdd ( PR && pr )

inline

Add a PR to the list of PRs

Parameters

pr	The PR to add to the end of the list.

Returns

This ContentPopularityRate.

prsBegin() [1/2]

std::list< PR >::iterator com::bbc::libmpdpp::ContentPopularityRate::prsBegin ( )

inline

Get a forward iterator for the start of the PR elements list

Returns

An iterator for the start of the PR elements list

prsBegin() [2/2]

std::list< PR >::const_iterator com::bbc::libmpdpp::ContentPopularityRate::prsBegin ( ) const

inline

Get a forward iterator for the start of the PR elements list

Returns

An iterator for the start of the PR elements list

prsEnd() [1/2]

std::list< PR >::iterator com::bbc::libmpdpp::ContentPopularityRate::prsEnd ( )

inline

Get a forward iterator for the end of the PR elements list

Returns

An iterator for the end of the PR elements list

prsEnd() [2/2]

std::list< PR >::const_iterator com::bbc::libmpdpp::ContentPopularityRate::prsEnd ( ) const

inline

Get a forward iterator for the end of the PR elements list

Returns

An iterator for the end of the PR elements list

prsRemove() [1/3]

ContentPopularityRate & com::bbc::libmpdpp::ContentPopularityRate::prsRemove

(

const PR &

pr

)

Remove an entry from the PR list by value

Parameters

pr	The PR value to remove from the list of PR elements.

Returns

This ContentPopularityRate.

prsRemove() [2/3]

ContentPopularityRate & com::bbc::libmpdpp::ContentPopularityRate::prsRemove

(

const std::list< PR >::const_iterator &

it

)

Remove an entry from the PR list by iterator

Parameters

it	An iterator pointing to the entry from the list of PR elements to remove.

Returns

This ContentPopularityRate.

prsRemove() [3/3]

ContentPopularityRate & com::bbc::libmpdpp::ContentPopularityRate::prsRemove

(

const std::list< PR >::iterator &

it

)

Remove an entry from the PR list by iterator

Parameters

it	An iterator pointing to the entry from the list of PR elements to remove.

Returns

This ContentPopularityRate.

---

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

• libmpd++/ContentPopularityRate.hh