VRUT::_general Class Reference

Add comment here for your module class. More...

#include <_general.h>

Inheritance diagram for VRUT::_general:

List of all members.

Public Member Functions
	_general (const MODULE_ID &_id, const wxString &_name, EventHandler *msgSink)
	Class constructor - do not alter.
virtual	~_general ()
	Class destructor - deinitialize your data.
virtual wxString	GetDesc () const
	Always overload method giving description for your module.
Protected Member Functions
virtual void	processEvent (wxCommandEvent &evt)
	Overload this to process events you need.
virtual void	run ()
	Overload only if you need to do some action every iteration of module's loop.
Protected Attributes
int	var
	Add any variables.
Parameter::ParameterIdentificator	varParamID
	Add var param identificator to register this as parameter.

---

Detailed Description

Add comment here for your module class.

Definition at line 28 of file _general.h.

---

Constructor & Destructor Documentation

VRUT::_general::_general	(	const MODULE_ID &	_id,
		const wxString &	_name,
		EventHandler *	msgSink
	)			[inline]

Class constructor - do not alter.

Initialize your variables Do not change other than param name when initializing param identificators

Register your params - choose GUI type or just register w/o GUI

Definition at line 64 of file _general.h.

                     : Module(_id, _name, 0, msgSink),
                     varParamID(_name, wxT("var"), _id)
              {
                     REGISTER_PARAM_GUI_SLIDER(varParamID, wxT("100"), 0, 200);
              }

virtual VRUT::_general::~_general

(

)

[inline, virtual]

Class destructor - deinitialize your data.

Definition at line 74 of file _general.h.

              {
              }

---

Member Function Documentation

virtual void VRUT::_general::processEvent

(

wxCommandEvent &

evt

)

[inline, protected, virtual]

Overload this to process events you need.

Always call base method

Remember to process registered param update events

Reimplemented from VRUT::Module.

Definition at line 37 of file _general.h.

              {
                     Module::processEvent(evt);

                     switch (evt.GetEventType())
                     {
                     case Event::EVT_PARAM_SET:
                            UPDATE_PARAM_FROM_EVENT_INT(varParamID, var, evt);
                            break;
                     }
              }

virtual void VRUT::_general::run

(

)

[inline, protected, virtual]

Overload only if you need to do some action every iteration of module's loop.

These actions below usually take place as reaction to events and not in run() method Use <className> in all your log messages

If using long time operations be sure to check for exit during them

If we are to exit return to main loop as soon as possible

Reimplemented from VRUT::Module.

Definition at line 51 of file _general.h.

              {
                     LOG(wxT("<_general>I am still alive"));
                     if (TestExit())
                            return;
              }

virtual wxString VRUT::_general::GetDesc

(

)

const [inline, virtual]

Always overload method giving description for your module.

Implements VRUT::Module.

Definition at line 79 of file _general.h.

              {
                     return wxT("This is my module");
              }

---

Member Data Documentation

int VRUT::_general::var [protected]

Add any variables.

Definition at line 32 of file _general.h.

Parameter::ParameterIdentificator VRUT::_general::varParamID [protected]

Add var param identificator to register this as parameter.

Definition at line 34 of file _general.h.

---

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

• /cygdrive/d/src/svn/vrut/trunk/modules/_general/_general.h