M3::IPlugin Class Reference

Interface for MaCh3 plugins and modules. More...

#include <CLI/API/plugin.hpp>

Inheritance diagram for M3::IPlugin:

Public Member Functions
virtual	~IPlugin ()=default
virtual int	Run ()=0
	Execute the plugin's main functionality. More...
virtual MaCh3ArgumentParser *	get_parser ()=0
	Get the argument parser for this plugin. More...

Detailed Description

Interface for MaCh3 plugins and modules.

All plugins and modules must implement this interface to provide argument parsing and execution functionality.

Definition at line 16 of file plugin.hpp.

Constructor & Destructor Documentation

~IPlugin()

virtual M3::IPlugin::~IPlugin ( )

virtualdefault

Member Function Documentation

get_parser()

virtual MaCh3ArgumentParser* M3::IPlugin::get_parser ( )

pure virtual

Get the argument parser for this plugin.

Returns

Pointer to the plugin's MaCh3ArgumentParser

Implemented in M3::ProcessMCMCModule, M3::GetPenaltyTermModule, M3::DiagMCMCModule, and M3::DynamicPlugin.

Run()

virtual int M3::IPlugin::Run ( )

pure virtual

Execute the plugin's main functionality.

Returns

Exit code (0 on success, non-zero on error)

Implemented in M3::ProcessMCMCModule, M3::GetPenaltyTermModule, M3::DiagMCMCModule, and M3::DynamicPlugin.

---

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

• CLI/API/plugin.hpp