mars::plugins::EntityView::EntityView Class Reference

#include <EntityView.h>

Public Member Functions
	EntityView (lib_manager::LibManager *theManager)
	~EntityView ()
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...
void	closedWidget ()
Public Member Functions inherited from mars::interfaces::MarsPluginTemplateGUI
	MarsPluginTemplateGUI (lib_manager::LibManager *theManager, std::string libName)
	~MarsPluginTemplateGUI ()
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::main_gui::MenuInterface
virtual	~MenuInterface ()
Public Member Functions inherited from mars::cfg_manager::CFGClient
	CFGClient ()
virtual	~CFGClient ()
virtual void	cfgParamCreated (cfgParamId _id)
virtual void	cfgParamRemoved (cfgParamId _id)

Private Attributes
cfg_manager::cfgPropertyStruct	example
EntityViewMainWindow *	view

Additional Inherited Members
Protected Attributes inherited from mars::interfaces::MarsPluginTemplateGUI
std::string	configPath
std::string	resourcesPath
main_gui::GuiInterface *	gui
Protected Attributes inherited from lib_manager::LibInterface
LibManager *	libManager
ModuleInfo	moduleInfo
Protected Attributes inherited from mars::interfaces::PluginInterface
ControlCenter *	control

Detailed Description

Definition at line 53 of file EntityView.h.

Constructor & Destructor Documentation

EntityView()

mars::plugins::EntityView::EntityView::EntityView

(

lib_manager::LibManager *

theManager

)

Definition at line 41 of file EntityView.cpp.

~EntityView()

mars::plugins::EntityView::EntityView::~EntityView

(

)

Definition at line 86 of file EntityView.cpp.

Member Function Documentation

cfgUpdateProperty()

void mars::plugins::EntityView::EntityView::cfgUpdateProperty ( cfg_manager::cfgPropertyStruct  _property )

virtual

Reimplemented from mars::cfg_manager::CFGClient.

Definition at line 101 of file EntityView.cpp.

closedWidget()

void mars::plugins::EntityView::EntityView::closedWidget

(

)

Definition at line 119 of file EntityView.cpp.

CREATE_MODULE_INFO()

mars::plugins::EntityView::EntityView::CREATE_MODULE_INFO

(

)

getLibName()

const std::string mars::plugins::EntityView::EntityView::getLibName ( ) const

inlinevirtual

Implements lib_manager::LibInterface.

Definition at line 66 of file EntityView.h.

getLibVersion()

int mars::plugins::EntityView::EntityView::getLibVersion ( ) const

inlinevirtual

Implements lib_manager::LibInterface.

Definition at line 64 of file EntityView.h.

init()

void mars::plugins::EntityView::EntityView::init ( void  )

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 45 of file EntityView.cpp.

menuAction()

void mars::plugins::EntityView::EntityView::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 108 of file EntityView.cpp.

receiveData()

void mars::plugins::EntityView::EntityView::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 95 of file EntityView.cpp.

reset()

void mars::plugins::EntityView::EntityView::reset ( void  )

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 83 of file EntityView.cpp.

update()

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

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 90 of file EntityView.cpp.

Member Data Documentation

example

cfg_manager::cfgPropertyStruct mars::plugins::EntityView::EntityView::example

private

Definition at line 89 of file EntityView.h.

view

EntityViewMainWindow* mars::plugins::EntityView::EntityView::view

private

Definition at line 90 of file EntityView.h.

---

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

• /Developer/bob-learning-dev/simulation/mars/plugins/entity_view/src/EntityView.h
• /Developer/bob-learning-dev/simulation/mars/plugins/entity_view/src/EntityView.cpp