triggerpipe_intf.h

Go to the documentation of this file.

 
#pragma once
#include <adtfucom3/adtf_ucom3.h>
#include <adtfbase/adtf_base.h>
 
namespace adtf
{
namespace streaming
{
namespace ant
{
    class ITriggerPipeItem;
    class ITriggerPipeSource : public ucom::ant::IObject
    {
    protected:
        ~ITriggerPipeSource() = default;
    public:
        ADTF_IID(ITriggerPipeSource, "trigger_pipe_source.ant.streaming.adtf.iid");
    public:
        enum tPriority : uint32_t
        {
            Invalid = 0,
            Lowest = 1,
            Lower = 30,
            BelowNormal = 40,
            Normal = 50,
            AboveNormal = 60,
            Higher = 70,
            Highest = 100
        };
 
    public:
        virtual tResult RegisterSubItem(const adtf::ucom::ant::iobject_ptr<ITriggerPipeItem>& pSubRun,
                                        tPriority ui32Prio) = 0;
        virtual tResult UnregisterSubItem(const adtf::ucom::ant::iobject_ptr<ITriggerPipeItem>& pSubRun) = 0;
 
        virtual tResult ChangePriority(const adtf::ucom::ant::iobject_ptr<ITriggerPipeItem>& pSubRun,
                                       tPriority ui32Prio) = 0;
        virtual tResult GetSubItems(adtf::ucom::ant::iobject_enum<const ITriggerPipeItem>& lstSubItems) const = 0;
    };
 
    class ITriggerPipeItem : public adtf::base::ant::IRunnable,
                             public ITriggerPipeSource
    {
        protected:
            ~ITriggerPipeItem() = default;
        public:
            ADTF_IID(ITriggerPipeItem, "trigger_pipe_item.ant.streaming.adtf.iid");
    };
 
    class ITriggerPipe : public adtf::ucom::ant::IObject
    {
    protected:
        ~ITriggerPipe() = default;
    public:
        ADTF_IID(ITriggerPipe, "trigger_pipe.ant.streaming.adtf.iid");
    public:
        
        virtual tResult GetFirstItem(adtf::ucom::ant::iobject_ptr<const ITriggerPipeSource>& pSubRu) const = 0;
 
        virtual tResult Open() = 0;
 
        virtual tResult Close() = 0;
 
        virtual tResult GetName(adtf::base::ant::IString&& strName) const = 0;
    };
  
 
} //namespace ant
 
namespace quiet
{
 
class ITriggerPipeHierachy : public ucom::ant::IObject
{
    protected:
        ~ITriggerPipeHierachy() = default;
    public:
        ADTF_IID(ITriggerPipeHierachy, "trigger_pipe_hierachy.quiet.streaming.adtf.iid");
 
        virtual tResult RegisterTriggerParent(const ant::ITriggerPipeSource* pParent) = 0;
 
        virtual tResult UnregisterTriggerParent(const ant::ITriggerPipeSource* pParent) = 0;
 
        virtual tResult GetTriggerParents(const ucom::nitro::ifunction<tResult(const ant::ITriggerPipeSource*)>& fnCallback) const = 0;
};
 
}
 
namespace riddler
{
 
template <typename ObjectType>
inline bool has_trigger_parent(const ObjectType* pChild)
{
    const auto pHierachy = adtf::ucom::ucom_cast<const quiet::ITriggerPipeHierachy*>(pChild);
    if (!pHierachy)
    {
        THROW_ERROR_DESC(ERR_NO_INTERFACE, "Object does not implement the trigger pipe hierachy interface.");
    }
 
    bool bHasParent = false;
    pHierachy->GetTriggerParents(adtf::ucom::make_function([&](const ant::ITriggerPipeSource*) -> tResult { bHasParent = true; RETURN_ERROR(ERR_CANCELED);}));
    return bHasParent;
}
 
}
 
using ant::ITriggerPipeSource;
using ant::ITriggerPipeItem;
using ant::ITriggerPipe;
using quiet::ITriggerPipeHierachy;
using riddler::has_trigger_parent;
 
} //namespace streaming
} // namespace adtf