ariba::utility::OvlVis Class Reference

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

Inherits ariba::utility::ServerVis.

Collaboration diagram for ariba::utility::OvlVis:
Collaboration graph
[legend]

List of all members.

Classes

class  TimedoutIcon

Public Types

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::_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 ()
virtual ~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)

Private Attributes

NetworkLinks networkLinks
LinkBubbles linkBubbles
NodeBubbles nodeBubbles
ShiftedNodeIcons shiftedNodeIcons
OnLinkIcons onLinkIcons

Detailed Description

Definition at line 64 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 371 of file OvlVis.h.

Definition at line 370 of file OvlVis.h.

Definition at line 372 of file OvlVis.h.

Definition at line 369 of file OvlVis.h.

Definition at line 374 of file OvlVis.h.

Definition at line 373 of file OvlVis.h.


Member Enumeration Documentation

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 162 of file OvlVis.h.


Constructor & Destructor Documentation

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

Definition at line 46 of file OvlVis.cpp.

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

Definition at line 49 of file OvlVis.cpp.


Member Function Documentation

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

Definition at line 67 of file OvlVis.h.

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

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

Reimplemented from ariba::utility::ServerVis.

void ariba::utility::OvlVis::visChangeLinkColor ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
NODE_COLORS  color 
) [virtual]
void ariba::utility::OvlVis::visChangeLinkColor ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
unsigned char  r,
unsigned char  g,
unsigned char  b 
) [virtual]

Change the link color

Implements ariba::utility::ServerVis.

Definition at line 397 of file OvlVis.cpp.

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

Referenced by visChangeLinkColor().

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

Change the link width

Definition at line 379 of file OvlVis.cpp.

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

void ariba::utility::OvlVis::visChangeNodeColor ( NETWORK_ID  network,
NodeID node,
NODE_COLORS  color 
) [virtual]
void ariba::utility::OvlVis::visChangeNodeColor ( NETWORK_ID  network,
NodeID node,
unsigned char  r,
unsigned char  g,
unsigned char  b 
) [virtual]

Change the color of the node.

Implements ariba::utility::ServerVis.

Definition at line 208 of file OvlVis.cpp.

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

Referenced by visChangeNodeColor().

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

Change the icon of a node.

Definition at line 247 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 105 of file OvlVis.cpp.

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

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::visCLIOInitMeasurement ( NETWORK_ID  network,
unsigned long  edgekey,
NodeID srcnode,
NodeID destnode,
string  info 
)
void ariba::utility::OvlVis::visConnect ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
string  info 
) [virtual]
void ariba::utility::OvlVis::visCreate ( NETWORK_ID  network,
NodeID node,
string  nodename,
string  info 
) [virtual]

Create a node in the network that is initially unconnected.

Implements ariba::utility::ServerVis.

Definition at line 83 of file OvlVis.cpp.

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

void ariba::utility::OvlVis::visDeleteLinkBubble ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode 
)
void ariba::utility::OvlVis::visDeleteLinkLabel ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode 
)
void ariba::utility::OvlVis::visDeleteNodeBubble ( NETWORK_ID  network,
NodeID node 
)
void ariba::utility::OvlVis::visDeleteNodeLabel ( NETWORK_ID  network,
NodeID node 
)

Delete the label of the node.

Definition at line 279 of file OvlVis.cpp.

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

void ariba::utility::OvlVis::visDeleteOnLinkIcon ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode 
)
void ariba::utility::OvlVis::visDeleteShiftedNodeIcon ( NETWORK_ID  network,
NodeID node 
)
void ariba::utility::OvlVis::visDisconnect ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
string  info 
) [virtual]
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 170 of file OvlVis.cpp.

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

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

Animate the message sending between two nodes

Definition at line 558 of file OvlVis.cpp.

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

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

Show a link label

Definition at line 439 of file OvlVis.cpp.

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

void ariba::utility::OvlVis::visShowNodeBubble ( NETWORK_ID  network,
NodeID node,
string  label 
)
void ariba::utility::OvlVis::visShowNodeLabel ( NETWORK_ID  network,
NodeID node,
string  label 
) [virtual]

Show the label of the node.

Implements ariba::utility::ServerVis.

Definition at line 263 of file OvlVis.cpp.

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

void ariba::utility::OvlVis::visShowOnLinkIcon ( NETWORK_ID  network,
NodeID srcnode,
NodeID destnode,
ICON_ID  iconID 
)
void ariba::utility::OvlVis::visShowShiftedNodeIcon ( NETWORK_ID  network,
NodeID node,
ICON_ID  iconID,
unsigned int  timeout = 0 
)
void ariba::utility::OvlVis::visShutdown ( NETWORK_ID  network,
NodeID node,
string  info 
) [virtual]

Delete a node from the network.

Implements ariba::utility::ServerVis.

Definition at line 188 of file OvlVis.cpp.

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


Member Data Documentation

Definition at line 377 of file OvlVis.h.

Referenced by visDeleteLinkBubble(), and visShowLinkBubble().

Definition at line 378 of file OvlVis.h.

Referenced by visDeleteNodeBubble(), and visShowNodeBubble().

Definition at line 380 of file OvlVis.h.

Referenced by visDeleteOnLinkIcon(), and visShowOnLinkIcon().

Definition at line 379 of file OvlVis.h.

Referenced by visDeleteShiftedNodeIcon(), and visShowShiftedNodeIcon().


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

Generated on Fri Dec 10 11:09:25 2010 for Ariba by  doxygen 1.6.1