Source Code for Demo Dynamic Properties

Location

./src/examples/src/adtf/filters/standard_filters/demo_dynamic_properties/

Build Environment

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

this implementation shows:

• how to use properties

Header

 
#pragma once
 
//*************************************************************************************************
#define CID_DEMO_DYNAMIC_PROPERTIES "demo_dynamic_properties.filter.adtf.cid"
 
using namespace adtf_util;
using namespace ddl;
using namespace adtf::ucom;
using namespace adtf::base;
using namespace adtf::streaming;
using namespace adtf::mediadescription;
using namespace adtf::filter;
 
 
class cDynamicPropertiesFilter : public cFilter
{
public:
    ADTF_CLASS_ID_NAME(cDynamicPropertiesFilter,
        CID_DEMO_DYNAMIC_PROPERTIES,
        "Demo Dynamic Properties");
 
    cDynamicPropertiesFilter();
    virtual ~cDynamicPropertiesFilter() = default;
 
private:
 
    class cProperties
    {
    public:
        property_variable<std::string> m_propFilename = {};
 
        cDynamicPropertiesFilter& m_oFilter;
        std::string m_strPropertyName;
 
    public:
        cProperties(cDynamicPropertiesFilter& oFilter, std::string strPropertyName);
        ~cProperties();
    };
 
    std::list<std::unique_ptr<cProperties>> m_lstProperties;
    property_variable<uint16_t> m_nDynamicPropertyByProperty = 0;
 
    std::list<std::unique_ptr<cProperties>> m_lstPropertiesFromFile;
    property_variable<cFilename> m_nDynamicPropertyByFile;
 
};

Implementation

 
#include <adtf3.h>
#include "demo_dynamic_properties.h"
#include <string>
#include <fstream>
 
ADTF_PLUGIN("Demo Dynamic Properties Filter Plugin", cDynamicPropertiesFilter);
 
 
cDynamicPropertiesFilter::cProperties::cProperties(cDynamicPropertiesFilter& oFilter, std::string strPropertyName):
    m_oFilter(oFilter),
    m_strPropertyName(strPropertyName)
{
    //Register Properties
    m_propFilename.SetDescription("Select a single file.");
 
    m_oFilter.RegisterPropertyVariable(m_strPropertyName.c_str(), m_propFilename);
}
 
cDynamicPropertiesFilter::cProperties::~cProperties()
{
    object_ptr<IProperties> pProperties;
    if (IS_OK(m_oFilter.GetProperties(pProperties)))
    {
        pProperties->RemoveProperty(m_strPropertyName.c_str());
    }
}
 
//This is to initialize the cDynamicPropertiesFilter
cDynamicPropertiesFilter::cDynamicPropertiesFilter()
{
    m_nDynamicPropertyByProperty.SetDescription("Amount of property instances");
    m_nDynamicPropertyByProperty.SetPropertyChangedCallback([this]()
    {
        m_lstProperties.clear();
        for (uint32_t nIndex = 0; nIndex < m_nDynamicPropertyByProperty; nIndex++)
        {
            m_lstProperties.push_back(std::make_unique<cProperties>(*this, std::string("by_property_") + std::to_string(nIndex)));
        }
    });
    RegisterPropertyVariable("dynamic_property_by_property", m_nDynamicPropertyByProperty);
 
    m_nDynamicPropertyByFile.SetDescription("A text file with properties per line");
    m_nDynamicPropertyByFile.SetPropertyChangedCallback([this]()
        {
            m_lstPropertiesFromFile.clear();
            std::ifstream oFile(m_nDynamicPropertyByFile->GetPtr());
            std::string strPropertyByLine;
            while (std::getline(oFile, strPropertyByLine))
            {
                m_lstPropertiesFromFile.push_back(std::make_unique<cProperties>(*this, strPropertyByLine));
            }
        });
 
    RegisterPropertyVariable("dynamic_property_by_file", m_nDynamicPropertyByFile);
 
    // sets a short description for the component
    set_description(*this, "Use this filter to provide a dynamic amount of properties.");
 
    // set help link to jump to documentation from ADTF Configuration Editor
    set_help_link(*this, "$(ADTF_DIR)/doc/adtf_html/page_demo_dynamic_properties.html");
}