Module

#include <Module.hpp>

Public Member Functions
virtual	~Module ()=default
virtual const std::string &	name () const =0
virtual const std::vector< std::unique_ptr< Command > > &	commands () const
virtual const std::vector< std::unique_ptr< DataProvider > > &	data_providers () const
virtual const std::vector< std::unique_ptr< FileReader > > &	file_readers () const
virtual const std::vector< std::unique_ptr< FileWriter > > &	file_writers () const

Detailed Description

Superclass of dynamically loaded modules

Definition at line 80 of file Module.hpp.

Constructor & Destructor Documentation

~Module()

virtual ~Module ( )

virtualdefault

Standard, empty virtual destructor

Member Function Documentation

commands()

virtual const std::vector<std::unique_ptr<Command> >& commands ( ) const

inlinevirtual

Optional, a list of commands the module provides, if any

Definition at line 88 of file Module.hpp.

data_providers()

virtual const std::vector<std::unique_ptr<DataProvider> >& data_providers ( ) const

inlinevirtual

Optional, a list of data providers (AKA, algorithms) the module provides, if any

Definition at line 90 of file Module.hpp.

file_readers()

virtual const std::vector<std::unique_ptr<FileReader> >& file_readers ( ) const

inlinevirtual

Optional, a list of file readers the module provides, if any

Definition at line 92 of file Module.hpp.

file_writers()

virtual const std::vector<std::unique_ptr<FileWriter> >& file_writers ( ) const

inlinevirtual

Optional, a list of file writers the module provides, if any

Definition at line 94 of file Module.hpp.

name()

virtual const std::string& name ( ) const

pure virtual

The name of the module, used only for display purposes

---

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

• /gfs-oceanweb/web/ocssw/ocssw_src/include/focs/Module.hpp