Public Member Functions | Private Attributes | List of all members
PJ::DataLoader Class Referenceabstract

The DataLoader plugin type is used to load files. More...

#include <dataloader_base.h>

Inheritance diagram for PJ::DataLoader:
Inheritance graph
[legend]

Public Member Functions

virtual const std::vector< const char * > & compatibleFileExtensions () const =0
 Provide a list of file extensions that this plugin can open. More...
 
 DataLoader ()=default
 
const ParserFactoriesparserFactories () const
 
virtual bool readDataFromFile (FileLoadInfo *fileload_info, PlotDataMapRef &destination)=0
 
void setParserFactories (ParserFactories *parsers)
 
virtual ~DataLoader ()=default
 
- Public Member Functions inherited from PJ::PlotJugglerPlugin
virtual const std::vector< QAction * > & availableActions ()
 
virtual bool isDebugPlugin ()
 
virtual const char * name () const =0
 Name of the plugin type, NOT the particular instance. More...
 
virtual QWidget * optionsWidget ()
 optionsWidget pointer to a persistent widget used to set the plugin options . More...
 
 PlotJugglerPlugin ()=default
 
virtual bool xmlLoadState (const QDomElement &parent_element)
 Override this method to load the status of the plugin from XML. More...
 
QDomElement xmlSaveState (QDomDocument &doc) const
 
virtual bool xmlSaveState (QDomDocument &doc, QDomElement &parent_element) const
 Override this method to save the status of the plugin to XML. More...
 

Private Attributes

ParserFactories_parser_factories = nullptr
 

Detailed Description

The DataLoader plugin type is used to load files.

The main application selects the correct plugin using the compatibleFileExtensions()

Definition at line 34 of file dataloader_base.h.

Constructor & Destructor Documentation

◆ DataLoader()

PJ::DataLoader::DataLoader ( )
default

◆ ~DataLoader()

virtual PJ::DataLoader::~DataLoader ( )
virtualdefault

Member Function Documentation

◆ compatibleFileExtensions()

virtual const std::vector<const char*>& PJ::DataLoader::compatibleFileExtensions ( ) const
pure virtual

Provide a list of file extensions that this plugin can open.

Implemented in DataLoadZcm, DataLoadCSV, DataLoadParquet, DataLoadMCAP, and DataLoadULog.

◆ parserFactories()

const ParserFactories* PJ::DataLoader::parserFactories ( ) const
inline

Definition at line 52 of file dataloader_base.h.

◆ readDataFromFile()

virtual bool PJ::DataLoader::readDataFromFile ( FileLoadInfo fileload_info,
PlotDataMapRef destination 
)
pure virtual

◆ setParserFactories()

void PJ::DataLoader::setParserFactories ( ParserFactories parsers)
inline

Definition at line 47 of file dataloader_base.h.

Member Data Documentation

◆ _parser_factories

ParserFactories* PJ::DataLoader::_parser_factories = nullptr
private

Definition at line 58 of file dataloader_base.h.


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


plotjuggler
Author(s): Davide Faconti
autogenerated on Sun Aug 11 2024 02:24:31