Module Class Reference

Inheritance diagram for Module:

Public Member Functions
	Module (int example_param, bool example_flag)
void	run () override
int	print_status () override
Public Member Functions inherited from ModuleParams
	ModuleParams (ModuleParams *parent)
void	setParent (ModuleParams *parent)
	Sets the parent module. More...
	ModuleParams (const ModuleParams &)=delete
ModuleParams &	operator= (const ModuleParams &)=delete
	ModuleParams (ModuleParams &&)=delete
ModuleParams &	operator= (ModuleParams &&)=delete
Public Member Functions inherited from ListNode< ModuleParams *>
void	setSibling (ModuleParams * sibling)
const ModuleParams *	getSibling () const

Static Public Member Functions
static int	task_spawn (int argc, char *argv[])
static Module *	instantiate (int argc, char *argv[])
static int	custom_command (int argc, char *argv[])
static int	print_usage (const char *reason=nullptr)

Additional Inherited Members
Protected Member Functions inherited from ModuleParams
virtual void	updateParams ()
	Call this method whenever the module gets a parameter change notification. More...
virtual void	updateParamsImpl ()
	The implementation for this is generated with the macro DEFINE_PARAMETERS()
Protected Attributes inherited from ListNode< ModuleParams *>
ModuleParams *	_sibling

Member Function Documentation

custom_command()

int Module::custom_command ( int  argc, char *  argv[]  )

static

See also

ModuleBase

instantiate()

Module * Module::instantiate ( int  argc, char *  argv[]  )

static

See also

ModuleBase

print_status()

int Module::print_status ( )

override

See also

ModuleBase::print_status()

print_usage()

int Module::print_usage ( const char *  reason = nullptr )

static

See also

ModuleBase

run()

void Module::run ( )

override

See also

ModuleBase::run()

task_spawn()

int Module::task_spawn ( int  argc, char *  argv[]  )

static

See also

ModuleBase

---

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

• src/templates/module/module.h
• src/templates/module/module.cpp