PDI 1.8.0-alpha.2024-08-11

the PDI data interface

PDI::Context_proxy Class Reference
Inheritance diagram for PDI::Context_proxy:
PDI::Context

Public Member Functions

 Context_proxy (Context &ctx)
 Creates Context proxy without plugin logger.
 
 Context_proxy (Context &ctx, const std::string &logger_name, PC_tree_t logging_tree)
 Creates Context proxy.
 
void setup_logger (const std::string &logger_name, PC_tree_t logging_tree)
 Sets up logger.
 
Data_descriptordesc (const std::string &name) override
 Context::desc proxy for plugins.
 
Data_descriptordesc (const char *name) override
 Context::desc proxy for plugins.
 
Data_descriptoroperator[] (const std::string &name) override
 Context::operator[] proxy for plugins.
 
Data_descriptoroperator[] (const char *name) override
 Context::operator[] proxy for plugins.
 
Iterator begin () override
 Context::begin proxy for plugins.
 
Iterator end () override
 Context::end proxy for plugins.
 
void event (const char *name) override
 Context::event proxy for plugins.
 
Loggerlogger () override
 Returns plugin logger.
 
Loggerpdi_core_logger ()
 Returns pdi core logger.
 
Datatype_template_sptr datatype (PC_tree_t node) override
 Context::datatype proxy for plugins.
 
void add_datatype (const std::string &name, Datatype_template_parser parser) override
 Context::add_datatype proxy for plugins.
 
Callbackscallbacks () override
 Context::callbacks proxy for plugins.
 
void finalize_and_exit () override
 Finalizes PDI and exits application.
 
- Public Member Functions inherited from PDI::Context
virtual ~Context ()
 
virtual Data_descriptordesc (const std::string &name)=0
 Accesses the descriptor for a specific name.
 
virtual Data_descriptordesc (const char *name)=0
 Accesses the descriptor for a specific name.
 
virtual Data_descriptoroperator[] (const std::string &name)=0
 Accesses the descriptor for a specific name.
 
virtual Data_descriptoroperator[] (const char *name)=0
 Accesses the descriptor for a specific name.
 
virtual Iterator begin ()=0
 Returns an iterator on the first descriptor.
 
virtual Iterator end ()=0
 Returns an iterator past the last descriptor.
 
virtual void event (const char *name)=0
 Triggers a PDI "event".
 
virtual Loggerlogger ()=0
 Logger getter.
 
virtual Callbackscallbacks ()=0
 Callbacks of the context.
 
virtual Datatype_template_sptr datatype (PC_tree_t node)=0
 Creates a new datatype template from a paraconf-style config.
 
virtual void add_datatype (const std::string &name, Datatype_template_parser parser)=0
 Adds new datatype parser to the context.
 
virtual void finalize_and_exit ()=0
 Finalizes PDI and exits application.
 

Additional Inherited Members

- Public Types inherited from PDI::Context
typedef std::function< Datatype_template_sptr(Context &, PC_tree_t)> Datatype_template_parser
 A function that parses a PC_tree_t to create a datatype_template.
 
- Protected Member Functions inherited from PDI::Context
Iterator get_iterator (const std::unordered_map< std::string, std::unique_ptr< Data_descriptor > >::iterator &data)
 
Iterator get_iterator (std::unordered_map< std::string, std::unique_ptr< Data_descriptor > >::iterator &&data)
 

Constructor & Destructor Documentation

◆ Context_proxy() [1/2]

PDI::Context_proxy::Context_proxy ( Context ctx)

Creates Context proxy without plugin logger.

Parameters
[in]ctxcontext to make a proxy

◆ Context_proxy() [2/2]

PDI::Context_proxy::Context_proxy ( Context ctx,
const std::string &  logger_name,
PC_tree_t  logging_tree 
)

Creates Context proxy.

Parameters
[in]ctxcontext to make a proxy
[in]logger_namename of the logger (will be used in logger pattern)
[in]logging_treelogging yaml tree of the plugin

Member Function Documentation

◆ setup_logger()

void PDI::Context_proxy::setup_logger ( const std::string &  logger_name,
PC_tree_t  logging_tree 
)

Sets up logger.

Parameters
[in]logger_namename of the logger (will be used in logger pattern)
[in]logging_treelogging yaml tree of the plugin

◆ desc() [1/2]

Data_descriptor & PDI::Context_proxy::desc ( const std::string &  name)
overridevirtual

Context::desc proxy for plugins.

Implements PDI::Context.

◆ desc() [2/2]

Data_descriptor & PDI::Context_proxy::desc ( const char *  name)
overridevirtual

Context::desc proxy for plugins.

Implements PDI::Context.

◆ operator[]() [1/2]

Data_descriptor & PDI::Context_proxy::operator[] ( const std::string &  name)
overridevirtual

Context::operator[] proxy for plugins.

Implements PDI::Context.

◆ operator[]() [2/2]

Data_descriptor & PDI::Context_proxy::operator[] ( const char *  name)
overridevirtual

Context::operator[] proxy for plugins.

Implements PDI::Context.

◆ begin()

Iterator PDI::Context_proxy::begin ( )
overridevirtual

Context::begin proxy for plugins.

Implements PDI::Context.

◆ end()

Iterator PDI::Context_proxy::end ( )
overridevirtual

Context::end proxy for plugins.

Implements PDI::Context.

◆ event()

void PDI::Context_proxy::event ( const char *  name)
overridevirtual

Context::event proxy for plugins.

Parameters
[in]namename of the event

Implements PDI::Context.

◆ logger()

Logger & PDI::Context_proxy::logger ( )
overridevirtual

Returns plugin logger.

Returns
plugin logger

Implements PDI::Context.

◆ pdi_core_logger()

Logger & PDI::Context_proxy::pdi_core_logger ( )

Returns pdi core logger.

Returns
pdi core logger

◆ datatype()

Datatype_template_sptr PDI::Context_proxy::datatype ( PC_tree_t  node)
overridevirtual

Context::datatype proxy for plugins.

Implements PDI::Context.

◆ add_datatype()

void PDI::Context_proxy::add_datatype ( const std::string &  name,
Datatype_template_parser  parser 
)
overridevirtual

Context::add_datatype proxy for plugins.

Implements PDI::Context.

◆ callbacks()

Callbacks & PDI::Context_proxy::callbacks ( )
overridevirtual

Context::callbacks proxy for plugins.

Implements PDI::Context.

◆ finalize_and_exit()

void PDI::Context_proxy::finalize_and_exit ( )
overridevirtual

Finalizes PDI and exits application.

Implements PDI::Context.


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