#include <libmpd++/Descriptor.hh>

Inheritance diagram for com::bbc::libmpdpp::Descriptor:

Public Member Functions
	Descriptor ()=delete

	Descriptor (const Descriptor &other)

	Descriptor (Descriptor &&other)

virtual	~Descriptor ()

Descriptor &	operator= (const Descriptor &other)

Descriptor &	operator= (Descriptor &&other)

bool	operator== (const Descriptor &other) const

bool	has_value () const

Descriptor &	value (const std::nullopt_t &)

bool	has_id () const

Descriptor &	id (const std::nullopt_t &)


	Descriptor (const URI &scheme_id, const std::optional< std::string > &value=std::nullopt, const std::optional< std::string > &id=std::nullopt)
	Constructs a new Descriptor object.

	Descriptor (URI &&scheme_id, const std::optional< std::string > &value=std::nullopt, const std::optional< std::string > &id=std::nullopt)
	Constructs a new Descriptor object.


const URI &	schemeId () const

URI &	schemeId ()


Descriptor &	schemeId (const URI &scheme_id)

Descriptor &	schemeId (URI &&scheme_id)


const std::optional< std::string > &	value () const

std::optional< std::string > &	value ()


Descriptor &	value (const std::string &val)

Descriptor &	value (std::string &&val)


const std::optional< std::string > &	id () const

std::optional< std::string > &	id ()


Descriptor &	id (const std::string &id)

Descriptor &	id (std::string &&id)

Detailed Description

Descriptor class

This is a container for DASH MPD XML elements which use the DescriptorType from the XML schema. This type is defined in ISO 23009-1:2022 Clause 5.8.3.

Constructor & Destructor Documentation

◆ Descriptor() [1/5]

com::bbc::libmpdpp::Descriptor::Descriptor ( )

delete

Default constructor (deleted).

This constructor is explicitly deleted to prevent instantiation of a Descriptor object without the necessary initialization parameters. Users must utilize one of the provided parameterized constructors.

◆ Descriptor() [2/5]

com::bbc::libmpdpp::Descriptor::Descriptor	(	const URI &	scheme_id,
		const std::optional< std::string > &	value = std::nullopt,
		const std::optional< std::string > &	id = std::nullopt )

inline

Constructs a new Descriptor object.

This constructor initializes a Descriptor with a required scheme URI and optional value and identifier strings. The optional parameters default to std::nullopt when no value is provided.

Parameters

scheme_id	The URI specifying the scheme identifier for this descriptor.
value	An optional string value associated with the descriptor. Defaults to std::nullopt.
id	An optional identifier string that further describes the descriptor. Defaults to std::nullopt.

◆ Descriptor() [3/5]

com::bbc::libmpdpp::Descriptor::Descriptor	(	URI &&	scheme_id,
		const std::optional< std::string > &	value = std::nullopt,
		const std::optional< std::string > &	id = std::nullopt )

inline

Constructs a new Descriptor object.

This constructor initializes a Descriptor with a required scheme URI and optional value and identifier strings. The optional parameters default to std::nullopt when no value is provided.

Parameters

scheme_id	The URI specifying the scheme identifier for this descriptor.
value	An optional string value associated with the descriptor. Defaults to std::nullopt.
id	An optional identifier string that further describes the descriptor. Defaults to std::nullopt.

◆ Descriptor() [4/5]

com::bbc::libmpdpp::Descriptor::Descriptor ( const Descriptor & other )

inline

Copy constructor

Creates a new Descriptor object which is a copy of other.

Parameters

other The Descriptor object to copy.

◆ Descriptor() [5/5]

com::bbc::libmpdpp::Descriptor::Descriptor ( Descriptor && other )

inline

Move constructor

Creates a new Descriptor object which transfers the resources from other.

Parameters

other The ContentPopularityRate object to move.

◆ ~Descriptor()

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

inlinevirtual

Destructor

Member Function Documentation

◆ has_id()

bool com::bbc::libmpdpp::Descriptor::has_id ( ) const

inline

Check if the id attribute is set

Returns: true if the id attribute has been set.

◆ has_value()

bool com::bbc::libmpdpp::Descriptor::has_value ( ) const

inline

Check if the value attribute is set

Returns: true if the value attribute has been set.

◆ id() [1/5]

std::optional< std::string > & com::bbc::libmpdpp::Descriptor::id ( )

inline

Get the optional id attribute value

Returns: The optional id attribute value.

◆ id() [2/5]

const std::optional< std::string > & com::bbc::libmpdpp::Descriptor::id ( ) const

inline

Get the optional id attribute value

Returns: The optional id attribute value.

◆ id() [3/5]

Descriptor & com::bbc::libmpdpp::Descriptor::id ( const std::nullopt_t & )

inline

Unset the id attribute value

Returns: This Descriptor.

◆ id() [4/5]

Descriptor & com::bbc::libmpdpp::Descriptor::id ( const std::string & id )

inline

Set the @id attribute value

Parameters

id	The value to set for the @id attribute.

Returns: This Descriptor.

◆ id() [5/5]

Descriptor & com::bbc::libmpdpp::Descriptor::id ( std::string && id )

inline

Set the @id attribute value

Parameters

id	The value to set for the @id attribute.

Returns: This Descriptor.

◆ operator=() [1/2]

Descriptor & com::bbc::libmpdpp::Descriptor::operator= ( const Descriptor & other )

inline

Copy operator

Copies the values from other into this Descriptor object.

Parameters

other The Descriptor object to copy.

Returns: This Descriptor object.

◆ operator=() [2/2]

Descriptor & com::bbc::libmpdpp::Descriptor::operator= ( Descriptor && other )

inline

Move operator

Transfers the resources from other into this Descriptor object.

Parameters

other The Descriptor object to move.

Returns: This Descriptor object.

◆ operator==()

bool com::bbc::libmpdpp::Descriptor::operator== ( const Descriptor & other ) const

inline

Comparison operator

Parameters

other The other Descriptor to compare to this one.

Returns: true if the value of other is the same as the value of this Descriptor, otherwise false.

◆ schemeId() [1/4]

URI & com::bbc::libmpdpp::Descriptor::schemeId ( )

inline

Get the schemeId URI attribute value

Returns: The schemeId URI attribute value.

◆ schemeId() [2/4]

const URI & com::bbc::libmpdpp::Descriptor::schemeId ( ) const

inline

Get the schemeId URI attribute value

Returns: The schemeId URI attribute value.

◆ schemeId() [3/4]

Descriptor & com::bbc::libmpdpp::Descriptor::schemeId ( const URI & scheme_id )

inline

Set the @schemeIdUri attribute value

Parameters

scheme_id The value to set for the @schemeIdUri attribute.

Returns: This Descriptor.

◆ schemeId() [4/4]

Descriptor & com::bbc::libmpdpp::Descriptor::schemeId ( URI && scheme_id )

inline

Set the @schemeIdUri attribute value

Parameters

scheme_id The value to set for the @schemeIdUri attribute.

Returns: This Descriptor.

◆ value() [1/5]

std::optional< std::string > & com::bbc::libmpdpp::Descriptor::value ( )

inline

Get the optional id attribute value

Returns: The optional id attribute value.

◆ value() [2/5]

const std::optional< std::string > & com::bbc::libmpdpp::Descriptor::value ( ) const

inline

Get the optional id attribute value

Returns: The optional id attribute value.

◆ value() [3/5]

Descriptor & com::bbc::libmpdpp::Descriptor::value ( const std::nullopt_t & )

inline

Unset the value attribute

Returns: This Descriptor.

◆ value() [4/5]

Descriptor & com::bbc::libmpdpp::Descriptor::value ( const std::string & val )

inline

Set the @value attribute value

Parameters

val	The value to set for the @value attribute.

Returns: This Descriptor.

◆ value() [5/5]

Descriptor & com::bbc::libmpdpp::Descriptor::value ( std::string && val )

inline

Set the @value attribute value

Parameters

val	The value to set for the @value attribute.

Returns: This Descriptor.

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

libmpd++/Descriptor.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Descriptor() [1/5]

◆ Descriptor() [2/5]

◆ Descriptor() [3/5]

◆ Descriptor() [4/5]

◆ Descriptor() [5/5]

◆ ~Descriptor()

Member Function Documentation

◆ has_id()

◆ has_value()

◆ id() [1/5]

◆ id() [2/5]

◆ id() [3/5]

◆ id() [4/5]

◆ id() [5/5]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ schemeId() [1/4]

◆ schemeId() [2/4]

◆ schemeId() [3/4]

◆ schemeId() [4/4]

◆ value() [1/5]

◆ value() [2/5]

◆ value() [3/5]

◆ value() [4/5]

◆ value() [5/5]