samplequeue_intf.h

Go to the documentation of this file.

#pragma once
#include "sample_intf.h"
 
namespace adtf
{
namespace streaming
{
namespace ant
{
 
 
class ISampleQueue;

class  ISampleQueueEventSink
{
    protected:
        ~ISampleQueueEventSink() = default;
 
    public:
        typedef enum : uint8_t
        {
            SQE_SampleQueueInserted = 0,
            SQE_SampleQueueErased   = 1,
 
        } tSampleQueueEvent;
    public:
        virtual tResult OnSampleQueueEvent(uint32_t ui32Event,
                                           int nParam1,
                                           int nParam2,
                                           tTimeStamp tmTimeRange) = 0;
};

class  ISampleQueue : public adtf::ucom::ant::IObject
{
    protected:
        ~ISampleQueue() = default;
    public:
        ADTF_IID(ISampleQueue, "samplequeue.ant.streaming.adtf.iid");
 
    public:
        template <typename T>
        using iobject_ptr = adtf::ucom::ant::iobject_ptr < T >;
        template <typename T>
        using iobject_list = adtf::ucom::ant::iobject_list < T >;
    public:
        typedef enum : uint32_t
        {
            SQG_GetLast             = 0,
            SQG_GetNearest          = 1,
            SQG_GetNearestNewer     = 2,
            SQG_GetNearestOlder     = 3,
            SQG_GetNewest           = 4,
            SQG_GetOldest           = 5,

            SQG_GetUser             = 128
        } tSampleQueueGetMethod;

        virtual tResult Push(const iobject_ptr<ISample>& pSample) = 0;

        virtual tResult Pop(iobject_ptr<ISample>& pSample) = 0;
        virtual tResult Pop() = 0;

        virtual tResult Top(iobject_ptr<ISample>& pSample) = 0;

        virtual tResult Clear() = 0;

        virtual size_t   GetSize() = 0;

        virtual bool   Empty() = 0; 

        virtual tResult Get(iobject_ptr<ISample>& pSample,
                            tTimeStamp     tmTimeStamp, 
                            tTimeStamp     tmDeltaT,
                            uint32_t        ui32GetMethod) = 0;     
        virtual tResult GetSettings(tTimeStamp& tmTimeRange, size_t& szSizeRange) const = 0;
        virtual tResult SetSettings(const tTimeStamp tmTimeRange, const size_t szSizeRange) = 0;
        virtual void GetTimes(tTimeStamp& tmFirst, tTimeStamp& tmLast) const = 0;

        virtual tResult RegisterQueueEventSink(ISampleQueueEventSink* pQueueEventSink) = 0;

        virtual tResult UnregisterQueueEventSink(const ISampleQueueEventSink* pQueueEventSink) = 0;
};
 
        
 
 
} //namesapce ant
} //namespac streaming
} // namespace adtf