nBandwidthControl Class Reference

#include <nNetwork.h>

Collaboration diagram for nBandwidthControl:

[legend]

List of all members.

Public Types
enum	Usage { Usage_Planning, Usage_Execution }
Public Member Functions
	nBandwidthControl (nBandwidthControl *parent=NULL)
	~nBandwidthControl ()
void	Reset ()
void	SetRate (unsigned short rate)
unsigned short	Rate ()
REAL	Control (Usage planned)
void	Use (Usage planned, REAL bandwidth)
bool	CanSend ()
REAL	Score ()
void	Update (REAL ts)
Private Attributes
REAL	rateControlPlanned_
REAL	rateControl_
unsigned short	rate_
nBandwidthControl *	parent_

---

Detailed Description

Definition at line 197 of file nNetwork.h.

---

Member Enumeration Documentation

enum nBandwidthControl::Usage

Enumerator:

Usage_Planning
Usage_Execution

Definition at line 200 of file nNetwork.h.

    {
        Usage_Planning,
        Usage_Execution
    };

---

Constructor & Destructor Documentation

nBandwidthControl::nBandwidthControl

(

nBandwidthControl *

parent = NULL

)

Definition at line 1973 of file nNetwork.cpp.

References parent_, and Reset().

{
#ifdef DEBUG
    if ( parent )
        parent->numChildren_ ++;
    numChildren_ = 0;
#endif

    parent_ = parent;

Here is the call graph for this function:

nBandwidthControl::~nBandwidthControl

(

)

Definition at line 1986 of file nNetwork.cpp.

{
#ifdef DEBUG
    if ( parent_ )
        parent_->numChildren_ --;

    tASSERT( numChildren_ == 0 );

---

Member Function Documentation

void nBandwidthControl::Reset

(

)

Definition at line 1996 of file nNetwork.cpp.

Referenced by nBandwidthControl().

{
    rateControlPlanned_ = rateControl_ = 1000.0f;

Here is the caller graph for this function:

void nBandwidthControl::SetRate

(

unsigned short

rate

)

[inline]

Definition at line 210 of file nNetwork.h.

References rate_.

                                                              {
        rate_ = rate;
    }

unsigned short nBandwidthControl::Rate

(

)

[inline]

Definition at line 213 of file nNetwork.h.

References rate_.

                                {
        return rate_;
    }

REAL nBandwidthControl::Control

(

Usage

planned

)

[inline]

Definition at line 217 of file nNetwork.h.

References rateControl_, rateControlPlanned_, and Usage_Planning.

Referenced by nNetObject::SyncAll().

                                                        {
        return Usage_Planning == planned ? rateControlPlanned_ : rateControl_;
    }

Here is the caller graph for this function:

void nBandwidthControl::Use	(	Usage	planned,
		REAL	bandwidth
	)

Definition at line 2002 of file nNetwork.cpp.

Referenced by nSendBuffer::AddMessage(), nSendBuffer::Broadcast(), and nSendBuffer::Send().

{
    tRecorderSync< REAL >::Archive( "_RATE_CONTROL_USAGE", 4, bandwidth );

Here is the caller graph for this function:

bool nBandwidthControl::CanSend

(

)

[inline]

Definition at line 222 of file nNetwork.h.

References rateControlPlanned_.

Referenced by sn_SendPlanned1().

                                         {
        return rateControlPlanned_ > 0;
    }

Here is the caller graph for this function:

REAL nBandwidthControl::Score

(

)

[inline]

Definition at line 225 of file nNetwork.h.

References rate_, and rateControlPlanned_.

Referenced by nBandwidthArbitrator::Fill().

                                       {
        return rateControlPlanned_ / rate_;
    }

Here is the caller graph for this function:

void nBandwidthControl::Update

(

REAL

ts

)

Definition at line 2008 of file nNetwork.cpp.

{
    tRecorderSync< REAL >::Archive( "_RATE_CONTROL", 12, rateControl_ );
    tRecorderSync< REAL >::Archive( "_RATE_CONTROL_PLANNED", 12, rateControlPlanned_ );

    rateControl_ += ( rate_ * 1000 ) * ts;

    if ( rateControl_ > 1000.0f )
    {
        rateControl_ = 1000.0f;
    }

---

Member Data Documentation

REAL nBandwidthControl::rateControlPlanned_ [private]

Definition at line 231 of file nNetwork.h.

Referenced by CanSend(), Control(), and Score().

REAL nBandwidthControl::rateControl_ [private]

Definition at line 232 of file nNetwork.h.

Referenced by Control().

unsigned short nBandwidthControl::rate_ [private]

Definition at line 233 of file nNetwork.h.

Referenced by Rate(), Score(), and SetRate().

nBandwidthControl* nBandwidthControl::parent_ [private]

Definition at line 234 of file nNetwork.h.

Referenced by nBandwidthControl().

---

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

• src/network/nNetwork.h
• src/network/nNetwork.cpp

---