streammetatypesubstreams.h

Go to the documentation of this file.

#pragma once
#include <adtf_utils.h>
#include <adtfucom3/adtf_ucom3.h>
#include "streamtype_intf.h"
#include "streamtype.h"
#include <functional>
#include <type_traits>
#include <string_view>
#include <optional>
 
namespace adtf
{
namespace streaming
{
namespace hollow
{

struct stream_meta_type_substreams
{
    stream_meta_type_substreams() = default;

    static constexpr const char* const MetaTypeName = "adtf/substreams";
    static constexpr const char* const SubStreams = "substreams";
    static constexpr const char* const SubStreamsRequestProperties = "substreams_request_properties";

    static void SetProperties(const adtf::ucom::ant::iobject_ptr<adtf::base::ant::IProperties>& pProperties);

    static tResult IsCompatible(const adtf::streaming::ant::IStreamType& oTypeToCheck,
                                const adtf::streaming::ant::IStreamType& oTypeExpected);

    static bool HasSubStreams(const ant::IStreamType& oStreamType);

    static void ListSubStreams(const ant::IStreamType& oStreamType, std::function<void(const char*)> fnCallback);

    static void ListSubStreams(const ant::IStreamType& oStreamType, std::function<void(const char*, uint32_t)> fnCallback);

    static void ListSubStreams(const ant::IStreamType& oStreamType, std::function<void(std::string_view strName, uint32_t nId, const ucom::ant::iobject_ptr<const ant::IStreamType>& pType)> fnCallback);

    static uint32_t GetSubStreamId(const ant::IStreamType& oStreamType, const char* strSubStreamName);

    static ucom::ant::object_ptr<const ant::IStreamType> GetSubStreamType(const ant::IStreamType& oStreamType, const char* strSubStreamName);

    static void GetRequestProperties(base::ant::IProperties& oProperties, const ant::IStreamType& oStreamType, const char* strSubStreamName = "");
};

class cSubStreamTypes
{
    public:
        template <typename MetaType = stream_meta_type_substreams, typename = std::enable_if_t<is_stream_meta_type<MetaType>::value, MetaType>>
        cSubStreamTypes(const MetaType& /*oMetaType*/ = MetaType()):
            cSubStreamTypes(ucom::ucom_object_ptr_cast<ant::IStreamMetaType>(ucom::make_object_ptr<ant::stream_meta_type<MetaType>>()))
        {
        }

        cSubStreamTypes(const ucom::ant::iobject_ptr<const ant::IStreamMetaType>& pMetaType);

        virtual ~cSubStreamTypes();

        void SetSubStream(const char* strName, uint32_t nSubStreamId, const ucom::ant::iobject_ptr<const ant::IStreamType>& pType);

        void SetSubStream(std::string_view strName, uint32_t nSubStreamId, const ucom::ant::iobject_ptr<const ant::IStreamType>& pType);
        void AddSubStream(std::string_view strName, uint32_t nSubStreamId, const ucom::ant::iobject_ptr<const ant::IStreamType>& pType);

        void SetRequestProperties(const base::ant::IProperties& oProperties, const char* strSubStreamName = "");

        ucom::ant::object_ptr<const streaming::ant::IStreamType> GetSubStreamType(const char* strName) const;

        std::optional<
            std::tuple<uint32_t, ucom::object_ptr<const ant::IStreamType>, ucom::object_ptr<const base::ant::IProperties>>>
            GetSubStream(std::string_view strName) const noexcept;

        ucom::ant::object_ptr<ant::IStreamType> GetStreamType() const;
 
    protected:
        class cImplementation;
        std::unique_ptr<cImplementation> m_pImplementation;
};
 
} // namespace hollow
 
using hollow::stream_meta_type_substreams;
 
} // namespace streaming
} // namespace adtf