#include <__project__.h>

Public Member Functions
	__classname__ (lib_manager::LibManager *theManager)

	~__classname__ ()

int	getLibVersion () const

const std::string	getLibName () const

	CREATE_MODULE_INFO ()

void	init ()

void	reset ()

void	update (mars::interfaces::sReal time_ms)

virtual void	receiveData (const data_broker::DataInfo &info, const data_broker::DataPackage &package, int callbackParam)
	The DataBroker will call this method to notify the receiver of whenever the condition for which the receiver registered occur. More...

virtual void	cfgUpdateProperty (cfg_manager::cfgPropertyStruct _property)

void	menuAction (int action, bool checked=false)
	Called whenever a menu item is selected. More...

	__classname__ (lib_manager::LibManager *theManager)

	~__classname__ ()

int	getLibVersion () const

const std::string	getLibName () const

	CREATE_MODULE_INFO ()

void	init ()

void	reset ()

void	update (mars::interfaces::sReal time_ms)

virtual void	receiveData (const data_broker::DataInfo &info, const data_broker::DataPackage &package, int callbackParam)
	The DataBroker will call this method to notify the receiver of whenever the condition for which the receiver registered occur. More...

virtual void	cfgUpdateProperty (cfg_manager::cfgPropertyStruct _property)

Public Member Functions inherited from mars::interfaces::MarsPluginTemplate
	MarsPluginTemplate (lib_manager::LibManager *theManager, std::string libName)

	~MarsPluginTemplate ()

Public Member Functions inherited from lib_manager::LibInterface
	LibInterface (LibManager *theManager)

virtual	~LibInterface (void)

ModuleInfo	getModuleInfo () const

virtual void	newLibLoaded (const std::string &libName)

virtual void	createModuleInfo (void)

Public Member Functions inherited from mars::interfaces::PluginInterface
	PluginInterface (ControlCenter *control)

virtual	~PluginInterface (void)

virtual void	handleError (void)

virtual void	getSomeData (void *data)

Public Member Functions inherited from mars::data_broker::ReceiverInterface
	ReceiverInterface ()

virtual	~ReceiverInterface ()

Public Member Functions inherited from mars::cfg_manager::CFGClient
	CFGClient ()

virtual	~CFGClient ()

virtual void	cfgParamCreated (cfgParamId _id)

virtual void	cfgParamRemoved (cfgParamId _id)

Public Member Functions inherited from mars::interfaces::MarsPluginTemplateGUI
	MarsPluginTemplateGUI (lib_manager::LibManager *theManager, std::string libName)

	~MarsPluginTemplateGUI ()

Public Member Functions inherited from mars::main_gui::MenuInterface
virtual	~MenuInterface ()

Private Attributes
cfg_manager::cfgPropertyStruct	example

__classname___MainWin *	plugin_win

Additional Inherited Members
Protected Attributes inherited from mars::interfaces::MarsPluginTemplate
std::string	configPath

std::string	resourcesPath

Protected Attributes inherited from lib_manager::LibInterface
LibManager *	libManager

ModuleInfo	moduleInfo

Protected Attributes inherited from mars::interfaces::PluginInterface
ControlCenter *	control

Protected Attributes inherited from mars::interfaces::MarsPluginTemplateGUI
std::string	configPath

std::string	resourcesPath

main_gui::GuiInterface *	gui

Detailed Description

Definition at line 53 of file __project__.h.

Constructor & Destructor Documentation

◆ classname() [1/2]

mars::plugins::__namespace__::__classname__::__classname__ ( lib_manager::LibManager * theManager )

Definition at line 41 of file __project__.cpp.

◆ ~classname() [1/2]

mars::plugins::__namespace__::__classname__::~__classname__ ( )

Definition at line 76 of file __project__.cpp.

◆ classname() [2/2]

mars::plugins::__namespace__::__classname__::__classname__ ( lib_manager::LibManager * theManager )

◆ ~classname() [2/2]

mars::plugins::__namespace__::__classname__::~__classname__ ( )

Member Function Documentation

◆ cfgUpdateProperty() [1/2]

virtual void mars::plugins::__namespace__::__classname__::cfgUpdateProperty ( cfg_manager::cfgPropertyStruct _property )

virtual

Reimplemented from mars::cfg_manager::CFGClient.

◆ cfgUpdateProperty() [2/2]

void mars::plugins::__namespace__::__classname__::cfgUpdateProperty ( cfg_manager::cfgPropertyStruct _property )

virtual

Reimplemented from mars::cfg_manager::CFGClient.

Definition at line 91 of file __project__.cpp.

◆ CREATE_MODULE_INFO() [1/2]

mars::plugins::__namespace__::__classname__::CREATE_MODULE_INFO ( )

◆ CREATE_MODULE_INFO() [2/2]

mars::plugins::__namespace__::__classname__::CREATE_MODULE_INFO ( )

◆ getLibName() [1/2]

const std::string mars::plugins::__namespace__::__classname__::getLibName ( ) const

inlinevirtual

Implements lib_manager::LibInterface.

Definition at line 64 of file __project__.h.

◆ getLibName() [2/2]

const std::string mars::plugins::__namespace__::__classname__::getLibName ( ) const

inlinevirtual

Implements lib_manager::LibInterface.

Definition at line 66 of file __project__.h.

◆ getLibVersion() [1/2]

int mars::plugins::__namespace__::__classname__::getLibVersion ( ) const

inlinevirtual

Implements lib_manager::LibInterface.

Definition at line 62 of file __project__.h.

◆ getLibVersion() [2/2]

int mars::plugins::__namespace__::__classname__::getLibVersion ( ) const

inlinevirtual

Implements lib_manager::LibInterface.

Definition at line 64 of file __project__.h.

◆ init() [1/2]

void mars::plugins::__namespace__::__classname__::init ( )

virtual

Implements mars::interfaces::PluginInterface.

◆ init() [2/2]

void mars::plugins::__namespace__::__classname__::init ( void )

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 47 of file __project__.cpp.

◆ menuAction()

void mars::plugins::__namespace__::__classname__::menuAction	(	int	action,
		bool	checked = `false`
	)

virtual

Called whenever a menu item is selected.

Parameters

action	The action that is passed to the GuiInterface via addGenericMenuAction function.
checked	Indicates if the menu/menu item is checked or not.

Implements mars::main_gui::MenuInterface.

Definition at line 98 of file __project__.cpp.

◆ receiveData() [1/2]

virtual void mars::plugins::__namespace__::__classname__::receiveData	(	const data_broker::DataInfo &	info,
		const data_broker::DataPackage &	dataPackage,
		int	callbackParam
	)

virtual

The DataBroker will call this method to notify the receiver of whenever the condition for which the receiver registered occur.

Parameters

info	Information about the DataPackage.
dataPackage	The DataPackage containing all the data.
callbackParam	The `int` the receiver passed during registration. The default (the receiver didn't provide a callbackParam) is 0. This can be used to easily distinguish different registrations.

Implements mars::data_broker::ReceiverInterface.

◆ receiveData() [2/2]

void mars::plugins::__namespace__::__classname__::receiveData	(	const data_broker::DataInfo &	info,
		const data_broker::DataPackage &	dataPackage,
		int	callbackParam
	)

virtual

The DataBroker will call this method to notify the receiver of whenever the condition for which the receiver registered occur.

Parameters

info	Information about the DataPackage.
dataPackage	The DataPackage containing all the data.
callbackParam	The `int` the receiver passed during registration. The default (the receiver didn't provide a callbackParam) is 0. This can be used to easily distinguish different registrations.

Implements mars::data_broker::ReceiverInterface.

Definition at line 85 of file __project__.cpp.

◆ reset() [1/2]

void mars::plugins::__namespace__::__classname__::reset ( )

virtual

Implements mars::interfaces::PluginInterface.

◆ reset() [2/2]

void mars::plugins::__namespace__::__classname__::reset ( void )

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 73 of file __project__.cpp.

◆ update() [1/2]

void mars::plugins::__namespace__::__classname__::update ( mars::interfaces::sReal time_ms )

virtual

Implements mars::interfaces::PluginInterface.

◆ update() [2/2]

void mars::plugins::__namespace__::__classname__::update ( mars::interfaces::sReal time_ms )

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 80 of file __project__.cpp.

Member Data Documentation

◆ example

cfg_manager::cfgPropertyStruct mars::plugins::__namespace__::__classname__::example

private

Definition at line 88 of file __project__.h.

◆ plugin_win

__classname___MainWin* mars::plugins::__namespace__::__classname__::plugin_win

private

Definition at line 89 of file __project__.h.

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

/Developer/bob-learning-dev/simulation/mars/plugins/plugin_template/__gui_project__/src/__project__.h
/Developer/bob-learning-dev/simulation/mars/plugins/plugin_template/__gui_project__/src/__project__.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __classname__() [1/2]

◆ ~__classname__() [1/2]

◆ __classname__() [2/2]

◆ ~__classname__() [2/2]

Member Function Documentation

◆ cfgUpdateProperty() [1/2]

◆ cfgUpdateProperty() [2/2]

◆ CREATE_MODULE_INFO() [1/2]

◆ CREATE_MODULE_INFO() [2/2]

◆ getLibName() [1/2]

◆ getLibName() [2/2]

◆ getLibVersion() [1/2]

◆ getLibVersion() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ menuAction()

◆ receiveData() [1/2]

◆ receiveData() [2/2]

◆ reset() [1/2]

◆ reset() [2/2]

◆ update() [1/2]

◆ update() [2/2]

Member Data Documentation

◆ example

◆ plugin_win

◆ classname() [1/2]

◆ ~classname() [1/2]

◆ classname() [2/2]

◆ ~classname() [2/2]