omObject Class Reference
[GENERIC LIBRARY classes]

#include <omObject.h>

Inheritance diagram for omObject:


Public Member Functions
virtual void	Init ()
virtual void	Reload ()
virtual void	Start ()
virtual void	Stop ()
virtual void	Tick ()
virtual void	Action ()
virtual void	GoDown ()
virtual void	GoUp ()
virtual void	GoLeft ()
virtual void	GoRight ()
virtual void	NotifyMessage (wxString, wxArrayString)
virtual void	NotifyXYData (int, int)
virtual void	NotifyIntData (int)
virtual void	NotifyFloatData (float)
virtual void	NotifyTCPMessage (omTCPMessage)
virtual bool	IsYourWindow (void *)
virtual void	StopExecutor ()
virtual void	StartExecutor ()

Detailed Description

Superclass for event Handling.

This class is used as a superclass for every object in the OpenMAIA suite.
All the objects retrive event passed by the functions provided by the omObject class.
Every virtual method in the omObject send an event to the child class.
The child class must override the interested method to handle the event generated.

Member Function Documentation

void omObject::Action ( ) [virtual]

Action event is used in automatic and manual scan mode to tell to the object that the used selected ACTION function using keyboard, serial or other device.
The action function is used to select the current button in manual navigation mode and to select current scan block or current button in automatic scan mode.
Reimplemented in omUIKeyboard, omUITreeNode, maiaCommandParser, and maiaKeyboard.

void omObject::GoDown ( ) [virtual]

GoDown event is used in manual scan mode to tell to the object that the user selected DOWN function using keyboard, serial or other device.

Reimplemented in maiaCommandParser, and maiaKeyboard.

void omObject::GoLeft ( ) [virtual]

GoLeft event is used in manual scan mode to tell to the object that the user selected LEFT function using keyboard, serial or other device.

Reimplemented in maiaCommandParser, and maiaKeyboard.

void omObject::GoRight ( ) [virtual]

GoRight event is used in manual scan mode to tell to the object that the user selected RIGHT function using keyboard, serial or other device.

Reimplemented in maiaCommandParser, and maiaKeyboard.

void omObject::GoUp ( ) [virtual]

GoUp event is used in manual scan mode to tell to the object that the user selected UP function using keyboard, serial or other device.

Reimplemented in maiaCommandParser, and maiaKeyboard.

void omObject::Init ( ) [virtual]

The Init event is passed to initialize the class after the constructions.
In some cases you need to initizalize the class after the constructor call because the initialization needs that some objects are instantiated.
Reimplemented in omOptions, omUICommandParser, omUIGrantFocus2User, omUIKeyboard, omUIOptions, maiaCommandParser, and maiaKeyboard.

bool omObject::IsYourWindow ( void * ) [virtual]

IsYourWindow event is a request to the object that uses a window on the screen. This request is used to find out if the specified window is handled by the object. If so metohd return TRUE otherwhise return FALSE value.

Returns:
true or false

Reimplemented in omUIButton, omUIKeyboard, and omUITreeNode.

void omObject::NotifyFloatData ( float d ) [virtual]

Notify a generic float data to the object.
This event is used when you need to pass a generic float value to the class.

Parameters:

d fload data

void omObject::NotifyIntData ( int d ) [virtual]

Notify a generic integer data to the object.
This event is used when you need to pass a generic integer value to the class.

Parameters:

d integer data

void omObject::NotifyMessage ( wxString command,

wxArrayString parameters

) [virtual]

Notify a message to the object.
This event is used to notify a message coming from the TCP/IP network or from another object. The message is formed by a command and some parameters. The command is passed via command variablle and the parameters are passed via parameters variable separated by MAIASEPARATOR ($$$$$) symbol.

Parameters:

command command to notify

parameters parameters to notify

See also:
maiaTCPMessages.h

void omObject::NotifyTCPMessage ( omTCPMessage message ) [virtual]

Notify an incoming message from TCP stream.
Parameters:

message Received message.

Reimplemented in maiaCommandParser, and maiaconfigFrame.

void omObject::NotifyXYData ( int x,

int y

) [virtual]

Notify a generic coordinate data to the object.
This event is used when you need to pass some coordinate data to che object. For example some OpenMAIA device drivers pass the state of a pointer using NotifyXYData event.

Parameters:

x x coodrinate

y y coordinate

void omObject::Reload ( ) [virtual]

This method causes the reload of the options of the class. If the class has a timer associated this method enforce the stopping and the starting of the timer.
Reimplemented in omUIKeyboard, maiaCommandParser, and maiaKeyboard.

void omObject::Start ( ) [virtual]

Start event tells to the object to Start all the eventual timers used by the object.
Reimplemented in omExecutor, omJoystickDriver, omKeyboardDriver, omSerialDriver, omUIActionQueue, omUIGrantFocus2User, maiaCommandParser, and maiaKeyboard.

void omObject::StartExecutor ( ) [virtual]

Notify the StartExecutor event to the object.
This causes the object that uses an OpenMAIA executor to start it.
Reimplemented in omUICommandParser.

void omObject::Stop ( ) [virtual]

Stop event tells to the object to Stop all the eventual timers used by the object.
Reimplemented in omExecutor, omJoystickDriver, omKeyboardDriver, omSerialDriver, omUIActionQueue, omUIGrantFocus2User, maiaCommandParser, and maiaKeyboard.

void omObject::StopExecutor ( ) [virtual]

Notify the StopExecutor event to the object.
This causes the object that uses an OpenMAIA executor to stop it.
Reimplemented in omUICommandParser.

void omObject::Tick ( ) [virtual]

Tick event is used in automatic scan mode to pass the scal clock signal to the class that implements automatic scan.
Reimplemented in omUIKeyboard, and omUITreeNode.

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

omObject Class Reference [GENERIC LIBRARY classes]

Public Member Functions

Detailed Description

Member Function Documentation

omObject Class Reference
[GENERIC LIBRARY classes]