Descriptor.hh

Go to the documentation of this file.

#ifndef _BBC_PARSE_DASH_MPD_DESCRIPTOR_HH_
#define _BBC_PARSE_DASH_MPD_DESCRIPTOR_HH_
/*****************************************************************************
 * DASH MPD parsing library in C++: Descriptor class
 *****************************************************************************
 * Copyright: (C) 2025 British Broadcasting Corporation
 * Author(s): David Waring <david.waring2@bbc.co.uk>
 * License: LGPLv3
 *
 * For full license terms please see the LICENSE file distributed with this
 * library or refer to: https://www.gnu.org/licenses/lgpl-3.0.txt.
 */
#include <iostream>
#include <optional>
#include <string>
 
#include "macros.hh"
#include "URI.hh"

// Forward declarations for types only used by pointer or reference
namespace xmlpp {
    class Element;
    class Node;
}
 
LIBMPDPP_NAMESPACE_BEGIN
 
class MPD;
class Period;

class LIBMPDPP_PUBLIC_API Descriptor {
public:

    Descriptor() = delete;

    Descriptor(const URI &scheme_id, const std::optional<std::string> &value = std::nullopt, const std::optional<std::string> &id = std::nullopt)
        :m_schemeIdUri(scheme_id)
        ,m_value(value)
    {};
    Descriptor(URI &&scheme_id, const std::optional<std::string> &value = std::nullopt, const std::optional<std::string> &id = std::nullopt)
        :m_schemeIdUri(scheme_id)
        ,m_value(value)
    {};

 

    Descriptor(const Descriptor &other)
        :m_schemeIdUri(other.m_schemeIdUri)
        ,m_value(other.m_value)
        ,m_id(other.m_id)
    {};

    Descriptor(Descriptor &&other)
        :m_schemeIdUri(std::move(other.m_schemeIdUri))
        ,m_value(std::move(other.m_value))
        ,m_id(std::move(other.m_id))
    {};

    virtual ~Descriptor() {};

    Descriptor &operator=(const Descriptor &other) {
        m_schemeIdUri = other.m_schemeIdUri;
        m_value = other.m_value;
        m_id = other.m_id;
        return *this;
    };

    Descriptor &operator=(Descriptor &&other) {
        m_schemeIdUri = std::move(other.m_schemeIdUri);
        m_value = std::move(other.m_value);
        m_id = std::move(other.m_id);
        return *this;
    };

    bool operator==(const Descriptor &other) const {
        if (m_schemeIdUri != other.m_schemeIdUri) return false;
        if (m_value.has_value() != other.m_value.has_value()) return false;
        if (m_value.has_value() && m_value.value() != other.m_value.value()) return false;
        if (m_id.has_value() != other.m_id.has_value()) return false;
        if (m_id.has_value() && m_id.value() != other.m_id.value()) return false;
        return true;
    }

    const URI &schemeId() const { return m_schemeIdUri; };
    URI &schemeId() { return m_schemeIdUri; };

    Descriptor &schemeId(const URI &scheme_id) { m_schemeIdUri = scheme_id; return *this; };
    Descriptor &schemeId(URI &&scheme_id) { m_schemeIdUri = std::move(scheme_id); return *this; };

    bool has_value() const { return m_value.has_value(); };

    const std::optional<std::string> &value() const { return m_value; };
    std::optional<std::string> &value() { return m_value; };

    Descriptor &value(const std::nullopt_t&) { m_value.reset(); return *this; };
   
    Descriptor &value(const std::string &val) { m_value = val; return *this; };
    Descriptor &value(std::string &&val) { m_value = std::move(val); return *this; };

    bool has_id() const { return m_id.has_value(); };
    
    
    const std::optional<std::string> &id() const { return m_id; };
    std::optional<std::string> &id() { return m_id; };
    
    Descriptor &id(const std::nullopt_t&) { m_id.reset(); return *this; };

    Descriptor &id(const std::string &id) { m_id = id; return *this; };
    Descriptor &id(std::string &&id) { m_id = std::move(id); return *this; };

protected:
    friend class AdaptationSet;
    friend class MPD;
    friend class Period;
    friend class Representation;
    friend class RepresentationBase;

    Descriptor(xmlpp::Node &node);

    void setXMLElement(xmlpp::Element &element) const;
 
private:
    // Attributes
    URI m_schemeIdUri;                  //< @@schemeIdUri attribute value
    std::optional<std::string> m_value; //< The optional @@value attribute value
    std::optional<std::string> m_id;    //< The optional @@id attribute value 
};
 
LIBMPDPP_NAMESPACE_END
 
/* vim:ts=8:sts=4:sw=4:expandtab:
 */
#endif /*_BBC_PARSE_DASH_MPD_DESCRIPTOR_HH_*/