TCollector

List of predecestors:
PVM_CODEC
Files:
collect.h, collect.cpp
Desc. & Idea Warnings Methods Atributes Operators Specials


Description

This is the fundamental class for collector layers of child, parent and application processes. It contains common methods to all collector layers.

Up.gif (1072 bytes)


Warnings

Under construction! This document doesn't yet contain all methods and atributes, but only the key ones..

Up.gif (1072 bytes)


Methods

Public:
TCollector(int type)
virtual ~TCollector()

virtual BOOL Interrupt() = 0
TKernelInfo* GetKI(uint id)
BOOL IsKIReady(uint id)
Protected:
virtual TKernelInfo* CreateKI(uint id,int period)
Private:


TCollector(int type)

Constructor of the class.

Arguments:

type ... type of the process (see class
PVM_CODEC)

Returns:

nothing

arrow3u.gif (362 bytes) Up.gif (1072 bytes)


virtual BOOL Interrupt()

This abstract function is intended for sharing of time between the layers. The layer that posses the main control of the execution calls periodically this method to allow other layers to retrieve and send their messages.

Arguments:

none

Returns:

TRUE if any messages were retrieved from the PVM buffer

arrow3u.gif (362 bytes) Up.gif (1072 bytes)


TKernelInfo* GetKI(uint id)

Using this method you can retrieve the KI you have registered previously. Use method IsKIReady() to find out the state of the KI. Warning: the pointer to the KI you obtain points to object owned by collector layer, so do not destroy or change the object.

Arguments:

id ... ID of KI you request

Returns:

Pointer to the requested KI

arrow3u.gif (362 bytes) Up.gif (1072 bytes)


BOOL IsKIReady(uint id)

Gives the state of KI present in collector layer. The ready-condition depends on the type of collector and the type of KI also.

Arguments:

id ... ID of KI

Returns:

TRUE if the KI is ready

arrow3u.gif (362 bytes) Up.gif (1072 bytes)


virtual TKernelInfo* CreateKI(uint id,int period)

This method is intended to create an object of the proper class. E.g. to call the proper constructor of KI specified by the given ID.
This method has following mechanism:

Arguments:

id ... ID of KI to be created
period ... valid only in case that the GKI is created (see
TGlobalKI::TGKI()).

Returns:

pointer to created KI or NULL if the ID is not known

arrow3u.gif (362 bytes) Up.gif (1072 bytes)




Atributes

Public:
int MyAtribute
Protected:
Private:


int MyAtribute

Here write atribute's description.

arrow3u.gif (362 bytes) Up.gif (1072 bytes)




Operators

Public:
int MyOper(void)
Protected:
Private:


int MyOper(void)

Here write operator's description.

Arguments:

Returns:

arrow3u.gif (362 bytes) Up.gif (1072 bytes)




Specials

Here write specials.

Up.gif (1072 bytes)