mars::log_console::MainConsole Class Reference

#include <MainConsole.h>

Public Member Functions
	MainConsole (lib_manager::LibManager *theManager)
void	setupGUI ()
virtual	~MainConsole (void)
virtual void	add (const std::string &msg, data_broker::MessageType type)
virtual void	addError (const std::string &my_error,...)
virtual void	addWarning (const std::string &my_warning,...)
virtual void	addMessage (const std::string &my_message,...)
virtual void	menuAction (int action, bool checked=false)
	Called whenever a menu item is selected. More...
int	getLibVersion () const
const std::string	getLibName () const
	CREATE_MODULE_INFO ()
virtual void	cfgUpdateProperty (cfg_manager::cfgPropertyStruct _property)
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...
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::main_gui::MenuInterface
virtual	~MenuInterface ()
Public Member Functions inherited from mars::log_console::ConsoleInterface
	ConsoleInterface (void)
virtual	~ConsoleInterface (void)
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::data_broker::ReceiverInterface
	ReceiverInterface ()
virtual	~ReceiverInterface ()

Protected Slots
void	timerEvent (QTimerEvent *event)
void	onMessageTypeChanged (int buttonId, bool state)

Private Member Functions
void	setupCFG (void)

Private Attributes
main_gui::GuiInterface *	gui
data_broker::DataBrokerInterface *	dataBroker
ConsoleGUI *	consoleWidget
QMutex	consoleLock
std::vector< con_data >	messages
cfg_manager::CFGManagerInterface *	cfg
cfg_manager::cfgPropertyStruct	showOnStdError
cfg_manager::cfgPropertyStruct	maxMessages
bool	set_window_prop
int	ignore_next_resize

Additional Inherited Members
Protected Attributes inherited from lib_manager::LibInterface
LibManager *	libManager
ModuleInfo	moduleInfo

Detailed Description

Definition at line 62 of file MainConsole.h.

Constructor & Destructor Documentation

MainConsole()

mars::log_console::MainConsole::MainConsole

(

lib_manager::LibManager *

theManager

)

Definition at line 42 of file MainConsole.cpp.

~MainConsole()

mars::log_console::MainConsole::~MainConsole ( void  )

virtual

Definition at line 103 of file MainConsole.cpp.

Member Function Documentation

add()

void mars::log_console::MainConsole::add ( const std::string &  msg, data_broker::MessageType  type  )

virtual

Definition at line 127 of file MainConsole.cpp.

addError()

void mars::log_console::MainConsole::addError ( const std::string &  my_error,   ...  )

virtual

Implements mars::log_console::ConsoleInterface.

Definition at line 191 of file MainConsole.cpp.

addMessage()

void mars::log_console::MainConsole::addMessage ( const std::string &  my_message,   ...  )

virtual

Implements mars::log_console::ConsoleInterface.

Definition at line 209 of file MainConsole.cpp.

addWarning()

void mars::log_console::MainConsole::addWarning ( const std::string &  my_warning,   ...  )

virtual

Implements mars::log_console::ConsoleInterface.

Definition at line 200 of file MainConsole.cpp.

cfgUpdateProperty()

void mars::log_console::MainConsole::cfgUpdateProperty ( cfg_manager::cfgPropertyStruct  _property )

virtual

Reimplemented from mars::cfg_manager::CFGClient.

Definition at line 258 of file MainConsole.cpp.

CREATE_MODULE_INFO()

mars::log_console::MainConsole::CREATE_MODULE_INFO

(

)

getLibName()

const std::string mars::log_console::MainConsole::getLibName ( ) const

virtual

Implements lib_manager::LibInterface.

Definition at line 254 of file MainConsole.cpp.

getLibVersion()

int mars::log_console::MainConsole::getLibVersion ( ) const

virtual

Implements lib_manager::LibInterface.

Definition at line 250 of file MainConsole.cpp.

menuAction()

void mars::log_console::MainConsole::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 110 of file MainConsole.cpp.

onMessageTypeChanged

void mars::log_console::MainConsole::onMessageTypeChanged ( int  buttonId, bool  state  )

protectedslot

Definition at line 239 of file MainConsole.cpp.

receiveData()

void mars::log_console::MainConsole::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 269 of file MainConsole.cpp.

setupCFG()

void mars::log_console::MainConsole::setupCFG ( void  )

private

setupGUI()

void mars::log_console::MainConsole::setupGUI

(

)

Definition at line 63 of file MainConsole.cpp.

timerEvent

void mars::log_console::MainConsole::timerEvent ( QTimerEvent *  event )

protectedslot

Definition at line 218 of file MainConsole.cpp.

Member Data Documentation

cfg

cfg_manager::CFGManagerInterface* mars::log_console::MainConsole::cfg

private

Definition at line 103 of file MainConsole.h.

consoleLock

QMutex mars::log_console::MainConsole::consoleLock

private

Definition at line 100 of file MainConsole.h.

consoleWidget

ConsoleGUI* mars::log_console::MainConsole::consoleWidget

private

Definition at line 99 of file MainConsole.h.

dataBroker

data_broker::DataBrokerInterface* mars::log_console::MainConsole::dataBroker

private

Definition at line 98 of file MainConsole.h.

gui

main_gui::GuiInterface* mars::log_console::MainConsole::gui

private

Definition at line 97 of file MainConsole.h.

ignore_next_resize

int mars::log_console::MainConsole::ignore_next_resize

private

Definition at line 107 of file MainConsole.h.

maxMessages

cfg_manager::cfgPropertyStruct mars::log_console::MainConsole::maxMessages

private

Definition at line 104 of file MainConsole.h.

messages

std::vector<con_data> mars::log_console::MainConsole::messages

private

Definition at line 101 of file MainConsole.h.

set_window_prop

bool mars::log_console::MainConsole::set_window_prop

private

Definition at line 106 of file MainConsole.h.

showOnStdError

cfg_manager::cfgPropertyStruct mars::log_console::MainConsole::showOnStdError

private

Definition at line 104 of file MainConsole.h.

---

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

• /Developer/bob-learning-dev/simulation/mars/common/gui/log_console/src/MainConsole.h
• /Developer/bob-learning-dev/simulation/mars/common/gui/log_console/src/MainConsole.cpp