TITLE

AUTHOR
Version 
CREATEDATE

Table of Contents

Table of contents

Class Index
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
Edge	pagenum
GraphWidget	pagenum
MainWindow	pagenum
Node	pagenum
Point	pagenum
SettingsDialog	pagenum
Ui_MainWindow	pagenum
Ui::MainWindow	pagenum

Ui_SettingsDialog	pagenum
Ui::SettingsDialog	pagenum

Class Index
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
Edge  	pagenum
GraphWidget  	pagenum
Ui::MainWindow  	pagenum
MainWindow  	pagenum
Node  	pagenum
Point  	pagenum
Ui::SettingsDialog  	pagenum
SettingsDialog  	pagenum
Ui_MainWindow  	pagenum
Ui_SettingsDialog  	pagenum

Class Documentation
Edge Class Reference

#include <edge.h>
Public Types
enum { Type =  UserType + 2 }
Public Member Functions
Edge (Node *sourceNode, Node *destNode, CommModel *comm, MainWindow *mw, bool highlight)
Node * sourceNode () const 
Node * destNode () const 
void adjust ()
int type () const 
bool tooShort ()
Protected Member Functions
QRectF boundingRect () const 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)

Detailed Description
Graphical representation of an link between two model nodes 
Definition at line 58 of file edge.h.

Member Enumeration Documentation
anonymous enum
The user type 
Definition at line 71 of file edge.h.

Constructor & Destructor Documentation
Edge::Edge (Node *sourceNode, Node *destNode, CommModel *comm, MainWindow *mw, boolhighlight)
A graphical edge represents a link between two nodes 
Parameters:
sourceNode 	source node 	
destNode 	destination node 	
comm 	reference to the CommModel 	
mw 	the main window 	
highlight 	true when the edge should be highlighted 	
Definition at line 59 of file edge.cpp.

Member Function Documentation
void Edge::adjust ()
Adjusts the length of the line used to represent the edge 
Definition at line 114 of file edge.cpp.
QRectF Edge::boundingRect () const [protected]
Calculates the bounding rectangle box for this edge 
Returns:
bouding rectangle 
Definition at line 137 of file edge.cpp.
Node * Edge::destNode () const
Returns the destination node of this edge 
Returns:
destination node 
Definition at line 106 of file edge.cpp.
void Edge::paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget) [protected]
Uses a painter to draw this line 
Parameters:
painter 	the painter used 	
Definition at line 155 of file edge.cpp.
Node * Edge::sourceNode () const
Returns the source node of this edge 
Returns:
source node 
Definition at line 97 of file edge.cpp.
bool Edge::tooShort ()
Determines if two points are two close (less than 100 pixels apart) 
Returns:
true if too close 
Definition at line 82 of file edge.cpp.

The documentation for this class was generated from the following files:
edge.h
edge.cpp

GraphWidget Class Reference

#include <graphwidget.h>
Public Member Functions
GraphWidget (QWidget *parent=0, CommModel *comm=0)
void itemMoved ()
void updateGraph (std::vector< node * > _nodes)
void setSelectedIP (uint32_t newIP)
uint32_t getSelectedIP ()
void setSourceMac (mac_t newMac)
mac_t getSourceMac ()
void setDestinationMac (mac_t newMac)
mac_t getDestinationMac ()
void updateNodesAndEdges ()
MainWindow * getMainWindow ()
void setMainWindow (MainWindow *_mainWindow)
bool sameMacAddr (node *n1, node *n2)
void plotNodes ()
void setDoPhysics (bool val)
bool getDoPhysics ()
void highlightPath (std::vector< node * > path)
Public Attributes
QList< Node * > allNodes
Protected Member Functions
void timerEvent (QTimerEvent *event)
void drawBackground (QPainter *painter, const QRectF &rect)
bool checkIp (uint32_t ip_addr)
bool checkMac (node *nx)
Node * getNode (node *n)
bool hasEdge (Node *n, node *nb)
Protected Attributes
bool _doPhysics

Detailed Description
This is the viewer. It contains the graphical nodes and edges. 
Definition at line 71 of file graphwidget.h.

Constructor & Destructor Documentation
GraphWidget::GraphWidget (QWidget *parent = 0, CommModel *comModel = 0)
Constructor for GraphWidget 
Parameters:
parent 	the parent of this widget 	
comModel 	reference to the CommModel 	
Definition at line 57 of file graphwidget.cpp.

Member Function Documentation
bool GraphWidget::checkIp (uint32_tip_addr) [protected]
Searches the nodes for a matching ip address 
Parameters:
ip_addr 	the ip address to look for 	
Returns:
true if a node with a matching ip address was found 
Definition at line 123 of file graphwidget.cpp.
bool GraphWidget::checkMac (node *nx) [protected]
Checks the mac address of a node 
Parameters:
nx 	the node to check 	
Returns:
true if the mac address matches 
Definition at line 141 of file graphwidget.cpp.
void GraphWidget::drawBackground (QPainter *painter, const QRectF &rect) [protected]
Draws the background of the widget 
Parameters:
painter 	the painter used for drawing the background 	
rect 	the bounding box of the background 	
Definition at line 363 of file graphwidget.cpp.
mac_t GraphWidget::getDestinationMac ()
Gets the destination mac address 
Returns:
destination mac address 
Definition at line 473 of file graphwidget.cpp.
bool GraphWidget::getDoPhysics ()
Gets the private physics variable value 
Returns:
true if phyics are enabled 
Definition at line 591 of file graphwidget.cpp.
MainWindow * GraphWidget::getMainWindow ()
Gets the main window 
Returns:
main window 
Definition at line 79 of file graphwidget.cpp.
Node * GraphWidget::getNode (node *n) [protected]
Gets the graphical node representation for a model node 
Parameters:
n 	the model node 	
Returns:
graphical node representing this node, NULL if it doesn't exist 
Definition at line 160 of file graphwidget.cpp.
mac_t GraphWidget::getSourceMac ()
Gets the source mac address 
Returns:
source mac address 
Definition at line 482 of file graphwidget.cpp.
bool GraphWidget::hasEdge (Node *n, node *nb) [protected]
Checks if two model nodes are connected 
Parameters:
n 	node a 	
nb 	node b 	
Returns:
true if the two nodes are neighbors 
Definition at line 182 of file graphwidget.cpp.
void GraphWidget::highlightPath (std::vector< node * >path)
Highlights a set of edges that form a path 
Parameters:
path 	a vector nodes that are connected 	
Definition at line 599 of file graphwidget.cpp.
void GraphWidget::itemMoved ()
starts the timer when it item moves 
Definition at line 96 of file graphwidget.cpp.
void GraphWidget::plotNodes ()
Plots the nodes in a circle 
Definition at line 526 of file graphwidget.cpp.
bool GraphWidget::sameMacAddr (node *n1, node *n2)
Compares the mac addresses of the two nodes 
Parameters:
n1 	node 1 	
n2 	node 2 	
Returns:
true if n1 and n2 have the same mac address 
Definition at line 108 of file graphwidget.cpp.
void GraphWidget::setDestinationMac (mac_tnewMac)
Sets the destination mac address 
Parameters:
newMac 	mac address of the new destination node 	
Definition at line 456 of file graphwidget.cpp.
void GraphWidget::setDoPhysics (boolval)
Sets the private physics variable value 
Parameters:
val 	new physics variable 	
Definition at line 583 of file graphwidget.cpp.
void GraphWidget::setMainWindow (MainWindow *_mainWindow)
Sets the main window 
Parameters:
_mainWindow 	value for mainWindow 	
Definition at line 88 of file graphwidget.cpp.
void GraphWidget::setSelectedIP (uint32_tnewIP)
Sets a selected node  ip of the selected node 
Definition at line 425 of file graphwidget.cpp.
void GraphWidget::setSourceMac (mac_tnewMac)
Sets the source mac address 
Parameters:
newMac 	mac address of the new source node 	
Definition at line 439 of file graphwidget.cpp.
void GraphWidget::timerEvent (QTimerEvent *event) [protected]
Handles timer events 
Parameters:
event 	the event that is being handled 	
Definition at line 313 of file graphwidget.cpp.
void GraphWidget::updateGraph (std::vector< node * >nodes)
Updates the graph 
Parameters:
nodes 	a vector of all the nodes 	
Definition at line 199 of file graphwidget.cpp.
void GraphWidget::updateNodesAndEdges ()
a list of all the graphical nodes
Updates the location and appearance of nodes and egdges 
Definition at line 491 of file graphwidget.cpp.

The documentation for this class was generated from the following files:
graphwidget.h
graphwidget.cpp

Ui::MainWindow Class Reference

Inherits Ui_MainWindow.

Detailed Description
Definition at line 184 of file ui_mainwindow.h.

The documentation for this class was generated from the following file:
ui_mainwindow.h

MainWindow Class Reference
Public Slots
void updateList ()
Public Member Functions
MainWindow (QWidget *parent=0)
~MainWindow ()
int getInactiveThreshold ()
CommModel * getComm ()
void updateSettings (int _refreshRate, int _inactiveThreshold, bool _doPhysics, bool _showSignalStrength, bool _showThroughput, bool _showInactivityTime, bool _showLatency)
Public Attributes
SettingsDialog * settingsDialog
ReplayDialog * replayDialog

Detailed Description
Definition at line 18 of file mainwindow.h.

Constructor & Destructor Documentation
MainWindow::MainWindow (QWidget *parent = 0) [explicit]
Constructor of the MainWindow 
Definition at line 23 of file mainwindow.cpp.
MainWindow::~MainWindow ()
Destructor of the MainWindow. 
Definition at line 70 of file mainwindow.cpp.

Member Function Documentation
CommModel * MainWindow::getComm ()
Returns the current commModel. 
Returns:
commModel. 
Definition at line 356 of file mainwindow.cpp.
int MainWindow::getInactiveThreshold ()
Returns inactive threshold value 
Returns:
threshold value 
Definition at line 348 of file mainwindow.cpp.
void MainWindow::updateList () [slot]
Grab relevant data from the list of nodes, and display them in the list of node data.
It grabs relevant data from the list of nodes, and display them in the list of node data. 
Definition at line 192 of file mainwindow.cpp.

The documentation for this class was generated from the following files:
mainwindow.h
mainwindow.cpp

Node Class Reference

#include <node.h>
Public Types
enum { Type =  UserType + 1 }
Public Member Functions
Node (GraphWidget *graphWidget, bool _center, uint32_t _ip_addr, node *_node)
void addEdge (Edge *edge)
QList< Edge * > edges () const 
int type () const 
void calculateForces (bool doPhysics)
bool advance ()
QRectF boundingRect () const 
QPainterPath shape () const 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
uint32_t getIpAddr () const 
QString getIpAddrQString () const 
bool isActive () const 
void setInactive ()
void setActive ()
QPointF getPosition ()
node * getNodePointer ()
void settPosition (QPointF *np)
Static Public Member Functions
static bool macEqual (mac_t m1, mac_t m2)
Protected Member Functions
QVariant itemChange (GraphicsItemChange change, const QVariant &value)
void mousePressEvent (QGraphicsSceneMouseEvent *event)
void mouseReleaseEvent (QGraphicsSceneMouseEvent *event)

Detailed Description
Graphical representation of a model node 
Definition at line 59 of file node.h.

Constructor & Destructor Documentation
Node::Node (GraphWidget *graphWidget, bool_center, uint32_t_ip_addr, node *_node)
Constructor for Creating a new graphical ndoe 
Parameters:
graphWidget 	the widget it is placed on 	
_center 	the center of this graphical node 	
_ip_addre 	the ip address of this node 	
_node 	the model node that this graphical node represents 	
Definition at line 60 of file node.cpp.

Member Function Documentation
void Node::addEdge (Edge *edge)
adds and edge to this node 
Parameters:
edge 	the edge used to connect this node to another node 	
Definition at line 85 of file node.cpp.
bool Node::advance ()
Updates the position of this node 
Definition at line 207 of file node.cpp.
QRectF Node::boundingRect () const
Gets the bounding rectangle of this node 
Returns:
the bounding rectangle of this node 
Definition at line 220 of file node.cpp.
void Node::calculateForces (booldoPhysics)
Calcualtes the forces, when physics are enabled 
Parameters:
doPhysics 	whether or not do enable physics 	
Definition at line 147 of file node.cpp.
QList< Edge * > Node::edges () const
Gets the list of edges 
Returns:
QList with all of this graphical node's edges 
Definition at line 104 of file node.cpp.
uint32_t Node::getIpAddr () const
Gets the ip address of the model node 
Returns:
the ip address of the model node 
Definition at line 113 of file node.cpp.
QString Node::getIpAddrQString () const
Gets the String representation of this nodes ip address 
Definition at line 381 of file node.cpp.
node * Node::getNodePointer ()
Gets the model node 
Returns:
model node that it's representing 
Definition at line 95 of file node.cpp.
QPointF Node::getPosition ()
Gets the new position of this node 
Returns:
the new postion of this node 
Definition at line 373 of file node.cpp.
bool Node::isActive () const
Gets the active state of this node 
Returns:
true if active 
Definition at line 122 of file node.cpp.
QVariant Node::itemChange (GraphicsItemChangechange, const QVariant &value) [protected]
Gets the change variant 
Parameters:
change 	the graphical item change 	
value 	the address of the change 	
Returns:
QVariant of the chang 
Definition at line 314 of file node.cpp.
static bool Node::macEqual (mac_tm1, mac_tm2) [inline, static]
compares two mac addresses 
Returns:
true if they're equl 
Definition at line 93 of file node.h.
void Node::mousePressEvent (QGraphicsSceneMouseEvent *event) [protected]
Handles mouse presses 
Parameters:
event 	the mouse press event 	
Definition at line 333 of file node.cpp.
void Node::mouseReleaseEvent (QGraphicsSceneMouseEvent *event) [protected]
Handles the mouse release event 
Parameters:
event 	the mouse release event 	
Definition at line 363 of file node.cpp.
void Node::paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
Paints the grpahical node using the painter 
Parameters:
painter 	used to paint this graphical node 	
option 	options for painting this node 	
Definition at line 243 of file node.cpp.
void Node::setActive ()
Sets as active 
Definition at line 138 of file node.cpp.
void Node::setInactive ()
Sets the node as inactive 
Definition at line 130 of file node.cpp.
void Node::settPosition (QPointF *np)
Sets the position of this node 
Parameters:
np 	the new position 	
Definition at line 390 of file node.cpp.
QPainterPath Node::shape () const
Gets the path used to draw this node 
Returns:
the path used to draw this node 
Definition at line 231 of file node.cpp.
int Node::type () const [inline]
the user type 
Definition at line 68 of file node.h.

The documentation for this class was generated from the following files:
node.h
node.cpp

Point Struct Reference

#include <point.h>
Public Attributes
int xval
int yval

Detailed Description
Point class represents node location in the graphic widget. It contains the information about its location in x and y. 
Definition at line 8 of file point.h.

The documentation for this struct was generated from the following file:
point.h

Ui::SettingsDialog Class Reference

Inherits Ui_SettingsDialog.

Detailed Description
Definition at line 169 of file ui_settingsdialog.h.

The documentation for this class was generated from the following file:
ui_settingsdialog.h

SettingsDialog Class Reference
Public Member Functions
SettingsDialog (QWidget *parent=0)
void setMainWindow (MainWindow *window)
void updateSettings (int refresh, int inactiveThreshold, bool physics, bool latency, bool throughput, bool sigStr, bool inactivity)

Detailed Description
Definition at line 12 of file settingsdialog.h.

The documentation for this class was generated from the following files:
settingsdialog.h
settingsdialog.cpp

Ui_MainWindow Class Reference

Inherited by Ui::MainWindow.
Public Member Functions
void setupUi (QMainWindow *MainWindow)
void retranslateUi (QMainWindow *MainWindow)
Public Attributes
QWidget * centralWidget
QVBoxLayout * verticalLayout_3
QVBoxLayout * verticalLayout
QHBoxLayout * horizontalLayout_4
QPushButton * playButton
QPushButton * recordButton
QPushButton * playbackButton
QSpacerItem * horizontalSpacer
QPushButton * settingsButton
QHBoxLayout * horizontalLayout_3
QGraphicsView * graphicsView
QVBoxLayout * verticalLayout_2
QTreeView * treeView_2
QTreeView * treeView
QMenuBar * menuBar
QStatusBar * statusBar

Detailed Description
Definition at line 31 of file ui_mainwindow.h.

The documentation for this class was generated from the following file:
ui_mainwindow.h

Ui_SettingsDialog Class Reference

Inherited by Ui::SettingsDialog.
Public Member Functions
void setupUi (QDialog *SettingsDialog)
void retranslateUi (QDialog *SettingsDialog)
Public Attributes
QWidget * verticalLayoutWidget
QVBoxLayout * verticalLayout
QSpacerItem * horizontalSpacer
QFormLayout * formLayout
QLabel * label
QSpinBox * spinBox
QLabel * inactivityThresholdLabel
QLabel * label_2
QCheckBox * physicsCheckbox
QCheckBox * signalStrengthCheckbox
QCheckBox * throughputCheckbox
QCheckBox * inactivityCheckbox
QCheckBox * latencyCheckbox
QSpinBox * spinBox_2
QLabel * label_5
QDialogButtonBox * buttonBox

Detailed Description
Definition at line 30 of file ui_settingsdialog.h.

The documentation for this class was generated from the following file:
ui_settingsdialog.h

Index
INDEX