Class for input datapacks for transceiver functions, mapped to EngineDataPack python decorator. More...

Inheritance diagram for EngineDataPack:

Public Member Functions
	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...

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 >

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 FunctionManager *	getFunctionManager ()

Protected Member Functions inherited from TransceiverDataPackInterface
template<class TRANSCEIVER_DATAPACK >
PtrTemplates< TRANSCEIVER_DATAPACK >::shared_ptr	moveToSharedPtr ()

virtual TransceiverDataPackInterface::shared_ptr *	getTFInterpreterRegistry ()
	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

Class for input datapacks for transceiver functions, mapped to EngineDataPack python decorator.

Constructor & Destructor Documentation

EngineDataPack::EngineDataPack	(	const std::string &	keyword,
		const DataPackIdentifier &	datapackID,
		bool	isPreprocessed
	)

virtual EngineDataPack::~EngineDataPack ( )

overridevirtualdefault

datapack_identifiers_set_t EngineDataPack::getRequestedDataPackIDs ( ) const

overridevirtual

Returns datapack IDs of this DataPack that should be requested from the engines. TODO: Make protected.

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

overridevirtual

Execute Transceiver Function. Base class will simply call runTf on _function.

Parameters

args	Arguments for execution. Can be altered by any TransceiverDataPackInterfaces. Base class will only pass them along
kwargs	Keyword arguments for execution. Can be altered by any TransceiverDataPackInterfaces. Base class will only pass them along

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

nrp_general_library/nrp_general_library/transceiver_function/from_engine_datapack.h
nrp_general_library/nrp_general_library/transceiver_function/from_engine_datapack.cpp