ariba::utility::OvlVis Class Reference

#include <source/ariba/utility/misc/OvlVis.h>

List of all members.

Public Types

enum  _NETWORK_ID {
  NETWORK_ID_BASE_COMMUNICATION = 1, NETWORK_ID_BASE_OVERLAY = 2, NETWORK_ID_EONSON = 3, NETWORK_ID_MCPO = 4,
  NETWORK_ID_CLIO = 5, NETWORK_ID_VIDEOSTREAM = 6, NETWORK_ID_GAME = 7, NETWORK_ID_SECURITY = 8
}
enum  _NODE_COLORS { NODE_COLORS_GREY, NODE_COLORS_GREEN, NODE_COLORS_RED }
enum  _ICON_ID {
  ICON_ID_DEFAULT_NODE = 0, ICON_ID_PC = 1, ICON_ID_PC_WORLD = 2, ICON_ID_FAILURE = 3,
  ICON_ID_RED_CROSS = 4, ICON_ID_CHARACTER_A = 5, ICON_ID_CHARACTER_W = 6, ICON_ID_CAMERA = 7
}
typedef enum
ariba::utility::OvlVis::_NETWORK_ID 
NETWORK_ID
typedef enum
ariba::utility::OvlVis::_NODE_COLORS 
NODE_COLORS
typedef enum
ariba::utility::OvlVis::_ICON_ID 
ICON_ID

Public Member Functions

void visCreate (NETWORK_ID network, NodeID &node, string nodename, string info)
void visChangeStatus (NETWORK_ID network, NodeID &node, bool enable, string info)
void visConnect (NETWORK_ID network, NodeID &srcnode, NodeID &destnode, string info)
void visDisconnect (NETWORK_ID network, NodeID &srcnode, NodeID &destnode, string info)
void visFailedConnect (NETWORK_ID network, NodeID &srcnode, NodeID &destnode, string info)
void visShutdown (NETWORK_ID network, NodeID &node, string info)
void visChangeNodeColor (NETWORK_ID network, NodeID &node, unsigned char r, unsigned char g, unsigned char b)
void visChangeNodeColor (NETWORK_ID network, NodeID &node, NODE_COLORS color)
void visChangeNodeIcon (NETWORK_ID network, NodeID &node, ICON_ID icon)
void visShowNodeLabel (NETWORK_ID network, NodeID &node, string label)
void visDeleteNodeLabel (NETWORK_ID network, NodeID &node)
void visShowNodeBubble (NETWORK_ID network, NodeID &node, string label)
void visDeleteNodeBubble (NETWORK_ID network, NodeID &node)
void visShowShiftedNodeIcon (NETWORK_ID network, NodeID &node, ICON_ID iconID, unsigned int timeout=0)
void visDeleteShiftedNodeIcon (NETWORK_ID network, NodeID &node)
void visChangeLinkWidth (NETWORK_ID network, NodeID &srcnode, NodeID &destnode, unsigned int width)
void visChangeLinkColor (NETWORK_ID network, NodeID &srcnode, NodeID &destnode, unsigned char r, unsigned char g, unsigned char b)
void visChangeLinkColor (NETWORK_ID network, NodeID &srcnode, NodeID &destnode, NODE_COLORS color)
void visShowLinkLabel (NETWORK_ID network, NodeID &srcnode, NodeID &destnode, string label)
void visDeleteLinkLabel (NETWORK_ID network, NodeID &srcnode, NodeID &destnode)
void visShowOnLinkIcon (NETWORK_ID network, NodeID &srcnode, NodeID &destnode, ICON_ID iconID)
void visDeleteOnLinkIcon (NETWORK_ID network, NodeID &srcnode, NodeID &destnode)
void visShowLinkBubble (NETWORK_ID network, NodeID &srcnode, NodeID &destnode, string label)
void visDeleteLinkBubble (NETWORK_ID network, NodeID &srcnode, NodeID &destnode)
void visSendMessage (NETWORK_ID network, NodeID &startnode, NodeID &endnode)
void visCLIOInitMeasurement (NETWORK_ID network, unsigned long edgekey, NodeID &srcnode, NodeID &destnode, string info)
void visCLIOEndMeasurement (NETWORK_ID network, unsigned long edgekey, NodeID &srcnode, NodeID &destnode, string info, string value, string unit)

Static Public Member Functions

static OvlVisinstance ()

Protected Member Functions

 OvlVis ()
 ~OvlVis ()

Private Types

typedef pair< NodeID, NodeIDNodePair
typedef KeyMapping< NodePairNetworkLinks
typedef KeyMapping< NodePairLinkBubbles
typedef KeyMapping< NodeIDNodeBubbles
typedef KeyMapping< NodeIDShiftedNodeIcons
typedef KeyMapping< NodePairOnLinkIcons

Private Member Functions

 use_logging_h (OvlVis)
void sendMessage (const string msg, NETWORK_ID nid)
void sendSocket (const string msg)

Private Attributes

boost::asio::io_service io_service
tcp::socket socket
volatile bool socketOpened
NetworkLinks networkLinks
LinkBubbles linkBubbles
NodeBubbles nodeBubbles
ShiftedNodeIcons shiftedNodeIcons
OnLinkIcons onLinkIcons

Classes

class  TimedoutIcon


Detailed Description

Definition at line 70 of file OvlVis.h.


Member Typedef Documentation

The available icons for changing the icon of a node, showing an icon besides a node and showing an icon at a link.

Definition at line 400 of file OvlVis.h.

Definition at line 401 of file OvlVis.h.

Definition at line 402 of file OvlVis.h.

Definition at line 403 of file OvlVis.h.

Definition at line 404 of file OvlVis.h.

Definition at line 405 of file OvlVis.h.


Member Enumeration Documentation

Enumerator:
NETWORK_ID_BASE_COMMUNICATION 
NETWORK_ID_BASE_OVERLAY 
NETWORK_ID_EONSON 
NETWORK_ID_MCPO 
NETWORK_ID_CLIO 
NETWORK_ID_VIDEOSTREAM 
NETWORK_ID_GAME 
NETWORK_ID_SECURITY 

Definition at line 75 of file OvlVis.h.

Enumerator:
NODE_COLORS_GREY 
NODE_COLORS_GREEN 
NODE_COLORS_RED 

Definition at line 165 of file OvlVis.h.

The available icons for changing the icon of a node, showing an icon besides a node and showing an icon at a link.

Enumerator:
ICON_ID_DEFAULT_NODE 
ICON_ID_PC 
ICON_ID_PC_WORLD 
ICON_ID_FAILURE 
ICON_ID_RED_CROSS 
ICON_ID_CHARACTER_A 
ICON_ID_CHARACTER_W 
ICON_ID_CAMERA 

Definition at line 185 of file OvlVis.h.


Constructor & Destructor Documentation

ariba::utility::OvlVis::OvlVis (  )  [protected]

ariba::utility::OvlVis::~OvlVis (  )  [protected]

Definition at line 85 of file OvlVis.cpp.

References socket.


Member Function Documentation

ariba::utility::OvlVis::use_logging_h ( OvlVis   )  [private]

static OvlVis& ariba::utility::OvlVis::instance (  )  [inline, static]

Definition at line 73 of file OvlVis.h.

Referenced by ariba::utility::OvlVis::TimedoutIcon::eventFunction().

void ariba::utility::OvlVis::visCreate ( NETWORK_ID  network,
NodeID node,
string  nodename,
string  info 
)

Create a node in the network that is initially unconnected.

Definition at line 127 of file OvlVis.cpp.

References sendMessage(), ariba::utility::Identifier::toString(), and ariba::utility::Helper::ultos().

void ariba::utility::OvlVis::visChangeStatus ( NETWORK_ID  network,
NodeID node,
bool  enable,
string  info 
)

Change the status of a node -> enable/disable a node.

Definition at line 149 of file OvlVis.cpp.

References sendMessage(), ariba::utility::Identifier::toString(), and ariba::utility::Helper::ultos().

void ariba::utility::OvlVis::visConnect ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
string  info 
)

void ariba::utility::OvlVis::visDisconnect ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
string  info 
)

void ariba::utility::OvlVis::visFailedConnect ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
string  info 
)

Indicate that the connection procedure between two nodes failed.

Definition at line 214 of file OvlVis.cpp.

References sendMessage(), ariba::utility::Identifier::toString(), and ariba::utility::Helper::ultos().

void ariba::utility::OvlVis::visShutdown ( NETWORK_ID  network,
NodeID node,
string  info 
)

Delete a node from the network.

Definition at line 232 of file OvlVis.cpp.

References sendMessage(), ariba::utility::Identifier::toString(), and ariba::utility::Helper::ultos().

void ariba::utility::OvlVis::visChangeNodeColor ( NETWORK_ID  network,
NodeID node,
unsigned char  r,
unsigned char  g,
unsigned char  b 
)

Change the color of the node.

Definition at line 252 of file OvlVis.cpp.

References sendMessage(), ariba::utility::Identifier::toString(), and ariba::utility::Helper::ultos().

Referenced by visChangeNodeColor().

void ariba::utility::OvlVis::visChangeNodeColor ( NETWORK_ID  network,
NodeID node,
NODE_COLORS  color 
)

Change the color of the node.

Definition at line 272 of file OvlVis.cpp.

References NODE_COLORS_GREEN, NODE_COLORS_GREY, NODE_COLORS_RED, and visChangeNodeColor().

void ariba::utility::OvlVis::visChangeNodeIcon ( NETWORK_ID  network,
NodeID node,
ICON_ID  icon 
)

Change the icon of a node.

Definition at line 291 of file OvlVis.cpp.

References sendMessage(), ariba::utility::Identifier::toString(), and ariba::utility::Helper::ultos().

void ariba::utility::OvlVis::visShowNodeLabel ( NETWORK_ID  network,
NodeID node,
string  label 
)

Show the label of the node.

Definition at line 307 of file OvlVis.cpp.

References sendMessage(), ariba::utility::Identifier::toString(), and ariba::utility::Helper::ultos().

void ariba::utility::OvlVis::visDeleteNodeLabel ( NETWORK_ID  network,
NodeID node 
)

Delete the label of the node.

Definition at line 323 of file OvlVis.cpp.

References sendMessage(), ariba::utility::Identifier::toString(), and ariba::utility::Helper::ultos().

void ariba::utility::OvlVis::visShowNodeBubble ( NETWORK_ID  network,
NodeID node,
string  label 
)

void ariba::utility::OvlVis::visDeleteNodeBubble ( NETWORK_ID  network,
NodeID node 
)

void ariba::utility::OvlVis::visShowShiftedNodeIcon ( NETWORK_ID  network,
NodeID node,
ICON_ID  iconID,
unsigned int  timeout = 0 
)

void ariba::utility::OvlVis::visDeleteShiftedNodeIcon ( NETWORK_ID  network,
NodeID node 
)

void ariba::utility::OvlVis::visChangeLinkWidth ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
unsigned int  width 
)

Change the link width

Definition at line 423 of file OvlVis.cpp.

References ariba::utility::KeyMapping< T >::get(), networkLinks, sendMessage(), and ariba::utility::Helper::ultos().

void ariba::utility::OvlVis::visChangeLinkColor ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
unsigned char  r,
unsigned char  g,
unsigned char  b 
)

Change the link color

Definition at line 441 of file OvlVis.cpp.

References ariba::utility::KeyMapping< T >::get(), networkLinks, sendMessage(), and ariba::utility::Helper::ultos().

Referenced by visChangeLinkColor().

void ariba::utility::OvlVis::visChangeLinkColor ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
NODE_COLORS  color 
)

Change the link color

Definition at line 463 of file OvlVis.cpp.

References NODE_COLORS_GREEN, NODE_COLORS_GREY, NODE_COLORS_RED, and visChangeLinkColor().

void ariba::utility::OvlVis::visShowLinkLabel ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
string  label 
)

Show a link label

Definition at line 483 of file OvlVis.cpp.

References ariba::utility::KeyMapping< T >::get(), networkLinks, sendMessage(), and ariba::utility::Helper::ultos().

void ariba::utility::OvlVis::visDeleteLinkLabel ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode 
)

void ariba::utility::OvlVis::visShowOnLinkIcon ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
ICON_ID  iconID 
)

void ariba::utility::OvlVis::visDeleteOnLinkIcon ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode 
)

void ariba::utility::OvlVis::visShowLinkBubble ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
string  label 
)

void ariba::utility::OvlVis::visDeleteLinkBubble ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode 
)

void ariba::utility::OvlVis::visSendMessage ( NETWORK_ID  network,
NodeID startnode,
NodeID endnode 
)

Animate the message sending between two nodes

Definition at line 602 of file OvlVis.cpp.

References sendMessage(), ariba::utility::Identifier::toString(), and ariba::utility::Helper::ultos().

void ariba::utility::OvlVis::visCLIOInitMeasurement ( NETWORK_ID  network,
unsigned long  edgekey,
NodeID srcnode,
NodeID destnode,
string  info 
)

void ariba::utility::OvlVis::visCLIOEndMeasurement ( NETWORK_ID  network,
unsigned long  edgekey,
NodeID srcnode,
NodeID destnode,
string  info,
string  value,
string  unit 
)

void ariba::utility::OvlVis::sendMessage ( const string  msg,
NETWORK_ID  nid 
) [private]

void ariba::utility::OvlVis::sendSocket ( const string  msg  )  [private]

Definition at line 118 of file OvlVis.cpp.

References socket, and socketOpened.

Referenced by sendMessage().


Member Data Documentation

boost::asio::io_service ariba::utility::OvlVis::io_service [private]

boost asio stuff for connecting to ovlvis

Definition at line 396 of file OvlVis.h.

Referenced by OvlVis().

tcp::socket ariba::utility::OvlVis::socket [private]

Definition at line 397 of file OvlVis.h.

Referenced by OvlVis(), sendSocket(), and ~OvlVis().

volatile bool ariba::utility::OvlVis::socketOpened [private]

Definition at line 398 of file OvlVis.h.

Referenced by OvlVis(), and sendSocket().

Definition at line 408 of file OvlVis.h.

Referenced by visDeleteLinkBubble(), and visShowLinkBubble().

Definition at line 409 of file OvlVis.h.

Referenced by visDeleteNodeBubble(), and visShowNodeBubble().

Definition at line 410 of file OvlVis.h.

Referenced by visDeleteShiftedNodeIcon(), and visShowShiftedNodeIcon().

Definition at line 411 of file OvlVis.h.

Referenced by visDeleteOnLinkIcon(), and visShowOnLinkIcon().


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

Generated on Wed May 27 18:24:08 2009 for Ariba by  doxygen 1.5.6