Source Code for Demo Legacy Data Trigger Plugin

Location

./src/examples/src/adtf/filters/adtf2_legacy/legacy_data_filter/

Build Environment

To see how to set up the build environment have a look at ADTF CMake Environment

this implementation shows:

• how to port an ADTF 2 Filter to ADTF 3 with the help of adtf::adtf2::ant::cLegacyFilter
• how to use the ADTF_LEGACY_FILTER_PLUGIN macro to implement a ported filter

Remarks

• We recommend to use Demo Data Trigger Plugin instead of the legacy API !

Header

 
#ifndef _DEMO_DATA_TRIGGER_FUNCTION_FILTER_H_
#define _DEMO_DATA_TRIGGER_FUNCTION_FILTER_H_
 
//*************************************************************************************************
#define CID_LEGACY_DATA_FILTER "demo_legacy_data_trigger.filter.adtf.cid"
 
using namespace adtf_util;
using namespace adtf::ucom;
using namespace adtf::streaming;
using namespace adtf::filter;
using namespace adtf::adtf2;
 
class cDemoLegacyDataFilter: public cLegacyFilter
{
    private:
        cLegacyInputPin m_oInputPin;
        cLegacyOutputPin m_oOutputPin;
 
        double m_fFactor;
 
    public:
        cDemoLegacyDataFilter();
        ~cDemoLegacyDataFilter();
 
        tResult Init(tInitStage eStage) override;
        tResult Start() override;
        tResult Stop() override;
        tResult Shutdown(tInitStage eStage) override;
 
    protected:
        tResult OnSampleReceived(cLegacyInputPin* pPin,
                                 const iobject_ptr<const ISample>& pSample) override;
        tResult OnTypeChanged(cLegacyInputPin* pPin,
                              const iobject_ptr<const IStreamType>& pType) override;
 
};
 
 
//*************************************************************************************************
#endif // _DEMO_DATA_TRIGGER_FUNCTION_FILTER_H_

Implementation

 
#include <adtf3.h>
#include <adtf2_support.h>
#include "demo_legacy_data_filter.h"
 
ADTF_LEGACY_FILTER_PLUGIN(CID_LEGACY_DATA_FILTER,
                          "Demo Legacy Data Trigger",
                          cDemoLegacyDataFilter);
 
cDemoLegacyDataFilter::cDemoLegacyDataFilter()
{
    SetPropertyFloat("factor", 1.0);
 
    // sets a short description for the component
    set_description(*this, "Use this legacy filter for transmitting a received value changed by a 'factor' property.");
}
 
cDemoLegacyDataFilter::~cDemoLegacyDataFilter()
{
}
 
tResult cDemoLegacyDataFilter::Init(tInitStage eStage)
{
    RETURN_IF_FAILED(cLegacyFilter::Init(eStage));
 
    if (eStage == tInitStage::StageFirst)
    {
        object_ptr<const IStreamType> pType = make_object_ptr<stream_type_plain<double>>();
 
        RETURN_IF_FAILED(m_oInputPin.Create("input", pType));
        RETURN_IF_FAILED(RegisterPin(m_oInputPin));
 
        RETURN_IF_FAILED(m_oOutputPin.Create("output", pType));
        RETURN_IF_FAILED(RegisterPin(m_oOutputPin));
    }
    else if (eStage == tInitStage::StageNormal)
    {
        m_fFactor = GetPropertyFloat("factor");
    }
 
    RETURN_NOERROR;
}
 
tResult cDemoLegacyDataFilter::Start()
{
    return cLegacyFilter::Start();
}
 
tResult cDemoLegacyDataFilter::OnSampleReceived(cLegacyInputPin* /* pPin */,
                                                const iobject_ptr<const ISample>& pSample)
{
    object_ptr<ISample> pOutputSample;
    RETURN_IF_FAILED(alloc_sample(pOutputSample, pSample->GetTime()));
 
    {
        __sample_write_lock(pOutputSample, double, pOutputValue);
        __sample_read_lock(pSample, double, pInputValue);
        *pOutputValue = *pInputValue * m_fFactor;
    }
 
    return m_oOutputPin.Transmit(object_ptr<const ISample>(pOutputSample));
}
 
tResult cDemoLegacyDataFilter::OnTypeChanged(cLegacyInputPin* pPin,
                                             const iobject_ptr<const IStreamType>& pType)
{
    return cLegacyFilter::OnTypeChanged(pPin, pType);
}
 
tResult cDemoLegacyDataFilter::Stop()
{
    return cLegacyFilter::Stop();
}
 
tResult cDemoLegacyDataFilter::Shutdown(tInitStage eStage)
{
    return cLegacyFilter::Shutdown(eStage);
}