- Main Page
- Classes
- Directories
- Related Pages

- Class List
- Class Hierarchy
- Class Members

# IModule Class Reference

Represent "algorithm instance" in the modular system. More...

`#include <imodule.h>`

Inheritance diagram for IModule:

List of all members.

## Public Member Functions

const char * | getType () const
| Return type of class.
virtual void | run ()=0
| runs module
virtual void | receiveMessage (TObject *mesg)
| handle messages receiving
virtual void | afterInstantiate ()
| called by ModuleType class after instantiation, for graphic setup etc.
void | printVariables (ostream &o) const
| print variables into stream
bool | operator== (const string &s) const
| test on module name (text comparsion)
VarInst * | getVariable (const string &varName)
| Return variable instance named varName. If no such instance exists, returns NULL.
VarInst * | operator[] (const string &varName)
| Same as function getVariable() via operator.
ModuleManager * | getManager ()
| returns pointer to module manager
ModuleType * | getModuleType ()
| returns pointer to module type

## Friends

class | ModuleType

## Detailed Description

Represent "algorithm instance" in the modular system.

Handles message receiving, store variables and provides methods to access them.

Date:
  01-29-2006

Author:
  Onrej Svejdar.

Todo:

Bug:

## Member Function Documentation

ModuleManager* IModule::getManager | ( |  | ) | `[inline]`

| returns pointer to module manager

Returns:
  module manager

ModuleType* IModule::getModuleType | ( |  | ) | `[inline]`

| returns pointer to module type

Returns:
  module type

const char * IModule::getType | ( |  | ) | const`[virtual]`

| Return type of class.

Returns:
  type of class

Reimplemented from TObject.

VarInst* IModule::getVariable | ( | const string & | varName | ) | `[inline]`

| Return variable instance named varName. If no such instance exists, returns NULL.

Parameters:

  | varName | name of variable instance

Returns:
  variable instance

bool IModule::operator== | ( | const string & | s | ) | const`[inline]`

| test on module name (text comparsion)

Parameters:

  | s | another's module name

Returns:
  true on match

VarInst* IModule::operator[] | ( | const string & | varName | ) | `[inline]`

| Same as function getVariable() via operator.

Parameters:

  | varName | name of variable instance

Returns:
  variable instance.

void IModule::printVariables | ( | ostream & | o | ) | const

| print variables into stream

Parameters:

  | o | output stream

virtual void IModule::receiveMessage | ( | TObject * | mesg | ) | `[inline, virtual]`

| handle messages receiving

Parameters:

  | mesg | pointer to object representing message

Reimplemented in TestAdd, and TestCompare.

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

- H:/projs/dotNET/eda/src/modulemanager/imodule.h
- H:/projs/dotNET/eda/src/modulemanager/imodule.cpp