NRP Core  1.4.1
PreprocessedDataPack Class Reference

Dummy alias class for EngineDataPack, mapped to PreprocessedDataPack python decorator. More...

Inheritance diagram for PreprocessedDataPack:
EngineDataPack TransceiverDataPackInterface PtrTemplates< TransceiverDataPackInterface >

Additional Inherited Members

- Public Types inherited from PtrTemplates< TransceiverDataPackInterface >
using shared_ptr = std::shared_ptr< TransceiverDataPackInterface >
 
using const_shared_ptr = std::shared_ptr< const TransceiverDataPackInterface >
 
using unique_ptr = std::unique_ptr< TransceiverDataPackInterface >
 
using const_unique_ptr = std::unique_ptr< const TransceiverDataPackInterface >
 
- Public Member Functions inherited from EngineDataPack
 EngineDataPack (const std::string &keyword, const DataPackIdentifier &datapackID, bool isPreprocessed)
 
virtual ~EngineDataPack () override=default
 
datapack_identifiers_set_t getRequestedDataPackIDs () const override
 Returns datapack IDs of this DataPack that should be requested from the engines. TODO: Make protected. More...
 
boost::python::object runTf (boost::python::tuple &args, boost::python::dict &kwargs, datapacks_set_t dataPacks) override
 Execute Transceiver Function. Base class will simply call runTf on _function. More...
 
- Public Member Functions inherited from TransceiverDataPackInterface
 TransceiverDataPackInterface ()=default
 
virtual ~TransceiverDataPackInterface ()=default
 
template<class TRANSCEIVER_DATAPACK >
TransceiverDataPackInterface::shared_ptr pySetup (const TransceiverDataPackInterface::shared_ptr &tfDataPack)
 Decorator call() function. Takes the lower decorator as a parameter. Moves the given class into a shared_ptr, which will be managed by the next decorator. More...
 
virtual const std::string & linkedEngineName () const
 Get name of engine this transceiver is linked to. More...
 
virtual bool isPreprocessing () const
 Indicates if this is a preprocessing function. More...
 
virtual datapack_identifiers_set_t updateRequestedDataPackIDs (datapack_identifiers_set_t &&datapackIDs=datapack_identifiers_set_t()) const
 Appends its own datapack requests onto datapackIDs. Uses getRequestedDataPackIDs to check which IDs are requested by this datapack. More...
 
- Static Public Member Functions inherited from TransceiverDataPackInterface
static void setTFInterpreter (FunctionManager *interpreter)
 Set global TF Interpreter. All Transceiver Functions will register themselves with it upon creation. More...
 
static const FunctionManagergetFunctionManager ()
 
- Protected Member Functions inherited from TransceiverDataPackInterface
template<class TRANSCEIVER_DATAPACK >
PtrTemplates< TRANSCEIVER_DATAPACK >::shared_ptr moveToSharedPtr ()
 
virtual TransceiverDataPackInterface::shared_ptrgetTFInterpreterRegistry ()
 Gets address of ptr under which the _functionManager has registered this TF. Mainly used during setup. More...
 
- Static Protected Attributes inherited from TransceiverDataPackInterface
static FunctionManager_functionManager = nullptr
 Pointer to TF Interpreter. Will be used to register a new TF function. More...
 

Detailed Description

Dummy alias class for EngineDataPack, mapped to PreprocessedDataPack python decorator.

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

Although EngineDataPack and PreprocessedDataPack are effectively the same class, they are initialized with different arguments in the python constructors.


The documentation for this class was generated from the following file: