User Manual, Developers Guide and API Documentation

wimac::ConnectionIdentifier Class Reference

ConnectionIdentifier hold information for one connection. More...

#include <ConnectionIdentifier.hpp>

Inheritance diagram for wimac::ConnectionIdentifier:

Inheritance graph
[legend]
Collaboration diagram for wimac::ConnectionIdentifier:

Collaboration graph
[legend]

List of all members.

Public Types

typedef unsigned int CID
enum  ConnectionType {
  NoType = 0, InitialRanging = 1, Basic = 2, PrimaryManagement = 3,
  SecondaryManagement = 4, Data = 5
}
 The type of the connection. More...
enum  Direction { NoDirection = 0x0, Downlink = 0x1, Uplink = 0x2, Bidirectional = 0x3 }
typedef int Frames
typedef std::list< PtrList
typedef wns::SmartPtr
< ConnectionIdentifier
Ptr
enum  QoSCategory {
  NoQoS = 0, Signaling = 1, UGS = 2, rtPS = 3,
  nrtPS = 4, BE = 5, MaxQoSCategory = BE
}
typedef wimac::StationID StationID

Public Member Functions

 ConnectionIdentifier (const ConnectionIdentifier &other)
 ConnectionIdentifier (StationID baseStation, CID cid, StationID subscriberStation, StationID remoteStation, ConnectionType connectionType, Direction direction, int qos)
 ConnectionIdentifier (StationID baseStation, StationID subscriberStation, StationID remoteStation, ConnectionType connectionType, Direction direction, int qos)
std::string doToString () const
 Prints the contents of the connection identifier as string.
CID getID () const
 Returns the connection id as integer.
bool integrityCheck () const
 Checks the data of the connection identifier for integrity.
bool operator< (const ConnectionIdentifier &rhs) const
bool operator== (const ConnectionIdentifier &rhs) const

Public Attributes

ConnectionIdentifier::StationID baseStation_
 ****** Stored informations about connection *************/
CID cid_
Frames ciNotListening_
 Simulator specific values, used by Scanning.
struct {
   wimac::ConnectionClassifier *   connectionClassifier
commandKeyClasses_
ConnectionType connectionType_
Direction direction_
int qos_
ConnectionIdentifier::StationID remoteStation_
ConnectionIdentifier::StationID subscriberStation_
bool valid_

Private Member Functions

 ConnectionIdentifier ()

Friends

class wimac::service::ConnectionManager
class wimac::tests::TestConnectionManager


Detailed Description

See also:
ConnectionManager

Definition at line 58 of file ConnectionIdentifier.hpp.


Member Typedef Documentation

Definition at line 67 of file ConnectionIdentifier.hpp.

Definition at line 98 of file ConnectionIdentifier.hpp.

Definition at line 65 of file ConnectionIdentifier.hpp.

Definition at line 64 of file ConnectionIdentifier.hpp.

Definition at line 66 of file ConnectionIdentifier.hpp.


Member Enumeration Documentation

Enumerator:
NoType 
InitialRanging 
Basic 
PrimaryManagement 
SecondaryManagement 
Data 

Definition at line 72 of file ConnectionIdentifier.hpp.

Enumerator:
NoDirection 
Downlink 
Uplink 
Bidirectional 

Definition at line 81 of file ConnectionIdentifier.hpp.

Enumerator:
NoQoS 
Signaling 
UGS 
rtPS 
nrtPS 
BE 
MaxQoSCategory 

Definition at line 88 of file ConnectionIdentifier.hpp.


Constructor & Destructor Documentation

ConnectionIdentifier::ConnectionIdentifier ( StationID  baseStation,
StationID  subscriberStation,
StationID  remoteStation,
ConnectionType  connectionType,
Direction  direction,
int  qos 
)

Definition at line 47 of file ConnectionIdentifier.cpp.

ConnectionIdentifier::ConnectionIdentifier ( StationID  baseStation,
CID  cid,
StationID  subscriberStation,
StationID  remoteStation,
ConnectionType  connectionType,
Direction  direction,
int  qos 
)

Definition at line 66 of file ConnectionIdentifier.cpp.

ConnectionIdentifier::ConnectionIdentifier ( const ConnectionIdentifier other  ) 

Definition at line 86 of file ConnectionIdentifier.cpp.

ConnectionIdentifier::ConnectionIdentifier (  )  [explicit, private]

Definition at line 32 of file ConnectionIdentifier.cpp.


Member Function Documentation

std::string ConnectionIdentifier::doToString (  )  const [virtual]

Implements wns::IOutputStreamable.

Definition at line 105 of file ConnectionIdentifier.cpp.

CID wimac::ConnectionIdentifier::getID (  )  const [inline]

Definition at line 121 of file ConnectionIdentifier.hpp.

bool ConnectionIdentifier::integrityCheck (  )  const

Todo:
Remove this method. This should not be necessary.

Definition at line 118 of file ConnectionIdentifier.cpp.

bool wimac::ConnectionIdentifier::operator< ( const ConnectionIdentifier rhs  )  const [inline]

Definition at line 134 of file ConnectionIdentifier.hpp.

bool wimac::ConnectionIdentifier::operator== ( const ConnectionIdentifier rhs  )  const [inline]

Definition at line 128 of file ConnectionIdentifier.hpp.


Friends And Related Function Documentation

friend class wimac::service::ConnectionManager [friend]

Definition at line 177 of file ConnectionIdentifier.hpp.

friend class wimac::tests::TestConnectionManager [friend]

Definition at line 178 of file ConnectionIdentifier.hpp.


Member Data Documentation

Primary keys for singularity of ConnectionIdentifier object.

Definition at line 153 of file ConnectionIdentifier.hpp.

Definition at line 154 of file ConnectionIdentifier.hpp.

Definition at line 164 of file ConnectionIdentifier.hpp.

Definition at line 168 of file ConnectionIdentifier.hpp.

Definition at line 159 of file ConnectionIdentifier.hpp.

Definition at line 160 of file ConnectionIdentifier.hpp.

Definition at line 161 of file ConnectionIdentifier.hpp.

Definition at line 158 of file ConnectionIdentifier.hpp.

Definition at line 157 of file ConnectionIdentifier.hpp.

Definition at line 172 of file ConnectionIdentifier.hpp.


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

Generated on Sat May 26 03:32:44 2012 for openWNS by  doxygen 1.5.5