---

QuartzClass Class Reference

The Quartz Class The Quartzclass is to send requests into a specific buffer with a specific frequency. It is the heartbeat of the client. More...

#include <quartz.h>

List of all members.

Public Methods
	QuartzClass ( Buffer*, int reqPackType, int freq = 15 )
	constructor for the quartzclass. More...
void	setFrequency ( int freq )
	Changes the frequency the quartz sends request-packages. More...
int	getFrequency ( void )
	gets the current frequency setting used by the QuartzThread itself to know with which frequency it shall work. More...
int	getRequestPacket ( void )
	gets the current type of request packet used by the QuartzThread itself to know with which packages it shall send. More...
Buffer*	getBuf ( void )
	gets the buffer used by the QuartzThread itself to know with into which buffer it shall write into. More...
Private Attributes
Buffer*	qbuf
	the pointer to the buffer the quartz shall write into. More...
int	requestPacket
	the type of package. More...
int	frequency
	the frequency (in requests per second). More...

---

Detailed Description

The Quartz Class The Quartzclass is to send requests into a specific buffer with a specific frequency. It is the heartbeat of the client.

Author(s):

xandi

Date:

250400

Definition at line 24 of file quartz.h.

{

    public:


    QuartzClass ( Buffer*, int reqPackType, int freq = 15 );


    void setFrequency ( int freq );



    int     QuartzClass::getFrequency     ( void );


    int     QuartzClass::getRequestPacket ( void );


    Buffer* QuartzClass::getBuf           ( void );

    private:

    Buffer* qbuf;
    int requestPacket; 
    int frequency; 

    }

---

Constructor & Destructor Documentation

QuartzClass::QuartzClass ( Buffer * bufferIn, int reqPackType, int freq = 15)

constructor for the quartzclass.

Parameters:

Buffer	The Buffer the quartz shall send the requests in
reqPackType	The type of request that shall be sent
freq	The frequency the quartz shall send the requests

Definition at line 25 of file quartz.cpp.

{
    qbuf = bufferIn;
    requestPacket = reqPackType;
    frequency = freq;

    #ifdef DEBUG
    fprintf(stderr,"[QUARTZCLASS (%d): %d %d %d\n",this,qbuf,requestPacket,frequency);
    #endif
    }

---

Member Function Documentation

Buffer * QuartzClass::getBuf ( void)

gets the buffer used by the QuartzThread itself to know with into which buffer it shall write into.

Returns:

the pointer to the buffer (Buffer*)

See also:

qbuf

Definition at line 51 of file quartz.cpp.

{
    return qbuf;
    }

int QuartzClass::getFrequency ( void)

gets the current frequency setting used by the QuartzThread itself to know with which frequency it shall work.

Returns:

the frequency (as a integer)

See also:

frequency

Definition at line 41 of file quartz.cpp.

{
    return frequency;
    }

int QuartzClass::getRequestPacket ( void)

gets the current type of request packet used by the QuartzThread itself to know with which packages it shall send.

Returns:

the packet-type (as a integer)

See also:

requestPacket

Definition at line 46 of file quartz.cpp.

{
    return requestPacket;
    }

void QuartzClass::setFrequency ( int freq)

Changes the frequency the quartz sends request-packages.

Parameters:

freq	The new frequency

See also:

frequency

Definition at line 36 of file quartz.cpp.

{
    frequency = freq;
    }

---

Member Data Documentation

int QuartzClass::frequency [private]

the frequency (in requests per second).

Definition at line 73 of file quartz.h.

Buffer * QuartzClass::qbuf [private]

the pointer to the buffer the quartz shall write into.

Definition at line 71 of file quartz.h.

int QuartzClass::requestPacket [private]

the type of package.

Definition at line 72 of file quartz.h.

---

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

• quartz.h
• quartz.cpp

---