mars::plugins::Plot3D::Plot3D Class Reference

#include <Plot3D.h>

Classes
class	PlotMapData
class	TimeMap

Public Member Functions
	Plot3D (lib_manager::LibManager *theManager)
	~Plot3D ()
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)
virtual void	preGraphicsUpdate (void)
void	menuAction (int action, bool checked=false)
	Called whenever a menu item is selected. More...
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)
Public Member Functions inherited from mars::interfaces::GraphicsUpdateInterface
	GraphicsUpdateInterface (void)
virtual	~GraphicsUpdateInterface (void)
virtual void	postGraphicsUpdate (void)

Protected Slots
void	hideWidget (void)
void	closeWidget (void)
void	motorSelected (unsigned long id)
void	addPlot (void)
void	removePlot (void)

Private Attributes
cfg_manager::cfgPropertyStruct	example
MotorPlotConfig *	myWidget
unsigned long	motorID
std::map< unsigned long, MotorPlot * >	plotMap
std::map< int, PlotMapData >	generalPlotMap
std::map< std::string, int >	timeStringMap
std::map< int, TimeMap >	timeMap
data_broker::DataPackageMapping	dbTimeMapping
data_broker::DataPackageMapping	dbNodeMapping
double	time
double	nodeZ

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 65 of file Plot3D.h.

Constructor & Destructor Documentation

Plot3D()

mars::plugins::Plot3D::Plot3D::Plot3D

(

lib_manager::LibManager *

theManager

)

Definition at line 45 of file Plot3D.cpp.

~Plot3D()

mars::plugins::Plot3D::Plot3D::~Plot3D

(

)

Definition at line 176 of file Plot3D.cpp.

Member Function Documentation

addPlot

void mars::plugins::Plot3D::Plot3D::addPlot ( void  )

protectedslot

Definition at line 270 of file Plot3D.cpp.

cfgUpdateProperty()

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

virtual

Reimplemented from mars::cfg_manager::CFGClient.

Definition at line 222 of file Plot3D.cpp.

closeWidget

void mars::plugins::Plot3D::Plot3D::closeWidget ( void  )

protectedslot

Definition at line 258 of file Plot3D.cpp.

CREATE_MODULE_INFO()

mars::plugins::Plot3D::Plot3D::CREATE_MODULE_INFO

(

)

getLibName()

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

inlinevirtual

Implements lib_manager::LibInterface.

Definition at line 97 of file Plot3D.h.

getLibVersion()

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

inlinevirtual

Implements lib_manager::LibInterface.

Definition at line 95 of file Plot3D.h.

hideWidget

void mars::plugins::Plot3D::Plot3D::hideWidget ( void  )

protectedslot

Definition at line 254 of file Plot3D.cpp.

init()

void mars::plugins::Plot3D::Plot3D::init ( void  )

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 49 of file Plot3D.cpp.

menuAction()

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

motorSelected

void mars::plugins::Plot3D::Plot3D::motorSelected ( unsigned long  id )

protectedslot

Definition at line 266 of file Plot3D.cpp.

preGraphicsUpdate()

void mars::plugins::Plot3D::Plot3D::preGraphicsUpdate ( void  )

virtual

Reimplemented from mars::interfaces::GraphicsUpdateInterface.

Definition at line 180 of file Plot3D.cpp.

receiveData()

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

removePlot

void mars::plugins::Plot3D::Plot3D::removePlot ( void  )

protectedslot

Definition at line 276 of file Plot3D.cpp.

reset()

void mars::plugins::Plot3D::Plot3D::reset ( void  )

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 173 of file Plot3D.cpp.

update()

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

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 183 of file Plot3D.cpp.

Member Data Documentation

dbNodeMapping

data_broker::DataPackageMapping mars::plugins::Plot3D::Plot3D::dbNodeMapping

private

Definition at line 130 of file Plot3D.h.

dbTimeMapping

data_broker::DataPackageMapping mars::plugins::Plot3D::Plot3D::dbTimeMapping

private

Definition at line 129 of file Plot3D.h.

example

cfg_manager::cfgPropertyStruct mars::plugins::Plot3D::Plot3D::example

private

Definition at line 121 of file Plot3D.h.

generalPlotMap

std::map<int, PlotMapData> mars::plugins::Plot3D::Plot3D::generalPlotMap

private

Definition at line 126 of file Plot3D.h.

motorID

unsigned long mars::plugins::Plot3D::Plot3D::motorID

private

Definition at line 124 of file Plot3D.h.

myWidget

MotorPlotConfig* mars::plugins::Plot3D::Plot3D::myWidget

private

Definition at line 123 of file Plot3D.h.

nodeZ

double mars::plugins::Plot3D::Plot3D::nodeZ

private

Definition at line 131 of file Plot3D.h.

plotMap

std::map<unsigned long, MotorPlot*> mars::plugins::Plot3D::Plot3D::plotMap

private

Definition at line 125 of file Plot3D.h.

time

double mars::plugins::Plot3D::Plot3D::time

private

Definition at line 131 of file Plot3D.h.

timeMap

std::map<int, TimeMap> mars::plugins::Plot3D::Plot3D::timeMap

private

Definition at line 128 of file Plot3D.h.

timeStringMap

std::map<std::string, int> mars::plugins::Plot3D::Plot3D::timeStringMap

private

Definition at line 127 of file Plot3D.h.

---

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

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