class PreprocessingFunction

Overview

Dummy alias class for TransceiverFunction, mapped to PreprocessingFunction python decorator. More…

class PreprocessingFunction: public TransceiverFunction {
};

Inherited Members

public:
    // typedefs

    typedef std::shared_ptr<T> shared_ptr;
    typedef std::shared_ptr<const T> const_shared_ptr;
    typedef std::unique_ptr<T> unique_ptr;
    typedef std::unique_ptr<const T> const_unique_ptr;

    // methods

    template <class TRANSCEIVER_DATAPACK>
    TransceiverDataPackInterface::shared_ptr pySetup(const TransceiverDataPackInterface::shared_ptr& tfDataPack);

    virtual const std::string& linkedEngineName() const;
    virtual bool isPreprocessing() const;

    virtual boost::python::object runTf(
        boost::python::tuple& args,
        boost::python::dict& kwargs,
        datapacks_set_t dataPacks
    );

    virtual datapack_identifiers_set_t updateRequestedDataPackIDs(datapack_identifiers_set_t&& datapackIDs = datapack_identifiers_set_t()) const;
    virtual datapack_identifiers_set_t getRequestedDataPackIDs() const;
    static void setTFInterpreter(FunctionManager* interpreter);
    static const FunctionManager* getFunctionManager();
    virtual const std::string& linkedEngineName() const;
    virtual bool isPreprocessing() const;
    TransceiverDataPackInterface::shared_ptr pySetup(boost::python::object transceiverFunction);

    virtual boost::python::object runTf(
        boost::python::tuple& args,
        boost::python::dict& kwargs,
        datapacks_set_t dataPacks
    );

Detailed Documentation

Dummy alias class for TransceiverFunction, mapped to PreprocessingFunction python decorator.

boost::python doesn’t allow to map two different names (TransceiverFunction and PreprocessingFunction in our case) to a single C++ class. This class acts as an ‘alias’ for TransceiverFunction and allows for two python decorators to be mapped to, effectively, a single class.

There’s no special behaviour of PreprocessingFunction with respect to the regular TransceiverFunction, but the decorator was created for semantic clarity and possible future developments.