A Discrete-Event Network Simulator
API
visualizer.core.Node Class Reference

Node class. More...

+ Inheritance diagram for visualizer.core.Node:
+ Collaboration diagram for visualizer.core.Node:

Public Member Functions

def __init__ (self, visualizer, node_index)
 Initialize function. More...
 
def add_link (self, link)
 Add link function. More...
 
def get_position (self)
 Get position function. More...
 
def has_mobility (self)
 Has mobility function. More...
 
def on_enter_notify_event (self, view, target, event)
 On Enter event handle. More...
 
def on_leave_notify_event (self, view, target, event)
 On Leave event handle. More...
 
def remove_link (self, link)
 Remove link function. More...
 
def set_color (self, color)
 Set color function. More...
 
def set_label (self, label)
 Set a label for the node. More...
 
def set_position (self, x, y)
 Set position function. More...
 
def set_size (self, size)
 Set size function. More...
 
def set_svg_icon (self, file_base_name, width=None, height=None, align_x=0.5, align_y=0.5)
 Set a background SVG icon for the node. More...
 
def tooltip_query (self, tooltip)
 Query tooltip. More...
 
def tooltip_query (self, tooltip)
 Returns tooltip text string. More...
 

Public Attributes

 canvas_item
 canvas item More...
 
 links
 links More...
 
 menu
 menu More...
 
 node_index
 node index More...
 
 svg_align_x
 svg align X More...
 
 svg_align_y
 svg align Y More...
 
 svg_item
 svg item More...
 
 visualizer
 visualier object More...
 

Properties

 highlighted = property(_get_highlighted, _set_highlighted)
 highlighted property More...
 
 selected = property(_get_selected, _set_selected)
 selected property More...
 

Private Member Functions

def _get_highlighted (self)
 Get highlighted function. More...
 
def _get_selected (self)
 Get selected function. More...
 
def _set_highlighted (self, value)
 Set highlighted function. More...
 
def _set_selected (self, value)
 Set selected function. More...
 
def _update_appearance (self)
 Update the node aspect to reflect the selected/highlighted state. More...
 
def _update_position (self)
 Update position function. More...
 
def _update_svg_position (self, x, y)
 Update svg position. More...
 

Private Attributes

 _color
 color More...
 
 _has_mobility
 has mobility model More...
 
 _highlighted
 is highlighted More...
 
 _label
 label More...
 
 _label_canvas_item
 label canvas More...
 
 _selected
 is selected More...
 
 _size
 size More...
 

Static Private Attributes

dictionary __gsignals__
 signal emitted whenever a tooltip is about to be shown for the node the first signal parameter is a python list of strings, to which information can be appended More...
 

Detailed Description

Node class.

Definition at line 73 of file core.py.

Constructor & Destructor Documentation

◆ __init__()

def visualizer.core.Node.__init__ (   self,
  visualizer,
  node_index 
)

Initialize function.

Parameters
selfThe object pointer.
visualizervisualizer object
node_indexnode index

Definition at line 116 of file core.py.

References visualizer.core.Node.__init__().

Referenced by visualizer.core.Node.__init__().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Function Documentation

◆ _get_highlighted()

def visualizer.core.Node._get_highlighted (   self)
private

Get highlighted function.

Parameters
selfclass object.
Returns
highlighted status

Definition at line 336 of file core.py.

References visualizer.core.Node._highlighted.

◆ _get_selected()

def visualizer.core.Node._get_selected (   self)
private

Get selected function.

Parameters
selfclass object.
Returns
selected status

Definition at line 315 of file core.py.

References visualizer.core.Node._selected.

◆ _set_highlighted()

def visualizer.core.Node._set_highlighted (   self,
  value 
)
private

Set highlighted function.

Parameters
selfclass object.
valueselected value
Returns
none

Definition at line 326 of file core.py.

References visualizer.core.Node._highlighted, and visualizer.core.Node._update_appearance().

+ Here is the call graph for this function:

◆ _set_selected()

def visualizer.core.Node._set_selected (   self,
  value 
)
private

Set selected function.

Parameters
selfclass object.
valueselected value
Returns
none

Definition at line 305 of file core.py.

References visualizer.core.Node._selected, and visualizer.core.Node._update_appearance().

+ Here is the call graph for this function:

◆ _update_appearance()

◆ _update_position()

def visualizer.core.Node._update_position (   self)
private

Update position function.

Parameters
selfclass object.
Returns
none

Definition at line 448 of file core.py.

References visualizer.core.Node.get_position(), visualizer.core.Channel.get_position(), grid.ScaleRenderer.get_position(), visualizer.core.Node.set_position(), and visualizer.core.Channel.set_position().

Referenced by visualizer.core.Node._update_appearance().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _update_svg_position()

def visualizer.core.Node._update_svg_position (   self,
  x,
  y 
)
private

Update svg position.

Parameters
selfclass object.
xx position
yy position
Returns
none

Definition at line 204 of file core.py.

References visualizer.core.Node.svg_align_x, visualizer.core.Node.svg_align_y, and visualizer.core.Node.svg_item.

Referenced by visualizer.core.Node.set_position(), and visualizer.core.Node.set_svg_icon().

+ Here is the caller graph for this function:

◆ add_link()

def visualizer.core.Node.add_link (   self,
  link 
)

Add link function.

Parameters
selfclass object.
linklink to add.
Returns
none

Definition at line 472 of file core.py.

References visualizer.core.Node.links, and visualizer.core.Channel.links.

◆ get_position()

def visualizer.core.Node.get_position (   self)

Get position function.

Parameters
selfclass object.
Returns
x and y position

Definition at line 439 of file core.py.

References visualizer.core.Node.canvas_item, visualizer.core.Channel.canvas_item, visualizer.core.WiredLink.canvas_item, and wifi_intrastructure_link.WifiLink.canvas_item.

Referenced by visualizer.core.Node._update_position().

+ Here is the caller graph for this function:

◆ has_mobility()

def visualizer.core.Node.has_mobility (   self)

◆ on_enter_notify_event()

def visualizer.core.Node.on_enter_notify_event (   self,
  view,
  target,
  event 
)

On Enter event handle.

Parameters
selfclass object.
viewview
targettarget
eventevent
Returns
none

Definition at line 282 of file core.py.

References visualizer.core.Node.highlighted.

◆ on_leave_notify_event()

def visualizer.core.Node.on_leave_notify_event (   self,
  view,
  target,
  event 
)

On Leave event handle.

Parameters
selfclass object.
viewview
targettarget
eventevent
Returns
none

Definition at line 293 of file core.py.

References visualizer.core.Node.highlighted.

◆ remove_link()

def visualizer.core.Node.remove_link (   self,
  link 
)

Remove link function.

Parameters
selfclass object.
linklink to add.
Returns
none

Definition at line 483 of file core.py.

References visualizer.core.Node.links, and visualizer.core.Channel.links.

◆ set_color()

def visualizer.core.Node.set_color (   self,
  color 
)

Set color function.

Parameters
selfclass object.
colorcolor to set.
Returns
none

Definition at line 458 of file core.py.

References visualizer.core.Node._color, and visualizer.core.Node._update_appearance().

+ Here is the call graph for this function:

◆ set_label()

def visualizer.core.Node.set_label (   self,
  label 
)

Set a label for the node.

Parameters
selfclass object.
labellabel to set
Returns
: an exception if invalid parameter.

Definition at line 191 of file core.py.

References visualizer.core.Node._label, and visualizer.core.Node._update_appearance().

+ Here is the call graph for this function:

◆ set_position()

◆ set_size()

def visualizer.core.Node.set_size (   self,
  size 
)

Set size function.

Parameters
selfclass object.
sizeselected size
Returns
none

Definition at line 347 of file core.py.

References visualizer.core.Node._size, and visualizer.core.Node._update_appearance().

+ Here is the call graph for this function:

◆ set_svg_icon()

def visualizer.core.Node.set_svg_icon (   self,
  file_base_name,
  width = None,
  height = None,
  align_x = 0.5,
  align_y = 0.5 
)

Set a background SVG icon for the node.

Parameters
file_base_namebase file name, including .svg extension, of the svg file. Place the file in the folder src/contrib/visualizer/resource.
widthscale to the specified width, in meters
heightscale to the specified height, in meters
align_xhorizontal alignment of the icon relative to the node position, from 0 (icon fully to the left of the node) to 1.0 (icon fully to the right of the node)
align_yvertical alignment of the icon relative to the node position, from 0 (icon fully to the top of the node) to 1.0 (icon fully to the bottom of the node)
Returns
a ValueError exception if invalid dimensions.

Definition at line 145 of file core.py.

References visualizer.core.Node._update_appearance(), visualizer.core.Node._update_svg_position(), visualizer.core.Node.canvas_item, visualizer.core.Channel.canvas_item, visualizer.core.WiredLink.canvas_item, wifi_intrastructure_link.WifiLink.canvas_item, visualizer.core.Node.svg_align_x, visualizer.core.Node.svg_align_y, visualizer.core.Node.svg_item, visualizer.base.transform_distance_simulation_to_canvas(), visualizer.core.Node.visualizer, interface_statistics.StatisticsCollector.visualizer, interface_statistics.ShowInterfaceStatistics.visualizer, ipv4_routing_table.ShowIpv4RoutingTable.visualizer, olsr.ShowOlsrRoutingTable.visualizer, and show_last_packets.ShowLastPackets.visualizer.

+ Here is the call graph for this function:

◆ tooltip_query()

Member Data Documentation

◆ __gsignals__

dictionary visualizer.core.Node.__gsignals__
staticprivate
Initial value:
= {
'query-extra-tooltip-info': (GObject.SignalFlags.RUN_LAST, None, (object,)),
}

signal emitted whenever a tooltip is about to be shown for the node the first signal parameter is a python list of strings, to which information can be appended

Definition at line 112 of file core.py.

◆ _color

visualizer.core.Node._color
private

color

Definition at line 132 of file core.py.

Referenced by visualizer.core.Node._update_appearance(), and visualizer.core.Node.set_color().

◆ _has_mobility

visualizer.core.Node._has_mobility
private

has mobility model

Definition at line 129 of file core.py.

Referenced by visualizer.core.Node.has_mobility().

◆ _highlighted

visualizer.core.Node._highlighted
private

is highlighted

Definition at line 131 of file core.py.

Referenced by visualizer.core.Node._get_highlighted(), and visualizer.core.Node._set_highlighted().

◆ _label

visualizer.core.Node._label
private

label

Definition at line 140 of file core.py.

Referenced by visualizer.core.Node._update_appearance(), and visualizer.core.Node.set_label().

◆ _label_canvas_item

visualizer.core.Node._label_canvas_item
private

label canvas

Definition at line 141 of file core.py.

Referenced by visualizer.core.Node._update_appearance(), and visualizer.core.Node.set_position().

◆ _selected

visualizer.core.Node._selected
private

◆ _size

visualizer.core.Node._size
private

◆ canvas_item

◆ links

◆ menu

visualizer.core.Node.menu

menu

Definition at line 136 of file core.py.

◆ node_index

◆ svg_align_x

visualizer.core.Node.svg_align_x

svg align X

Definition at line 138 of file core.py.

Referenced by visualizer.core.Node._update_svg_position(), and visualizer.core.Node.set_svg_icon().

◆ svg_align_y

visualizer.core.Node.svg_align_y

svg align Y

Definition at line 139 of file core.py.

Referenced by visualizer.core.Node._update_svg_position(), and visualizer.core.Node.set_svg_icon().

◆ svg_item

◆ visualizer

Property Documentation

◆ highlighted

visualizer.core.Node.highlighted = property(_get_highlighted, _set_highlighted)
static

◆ selected

visualizer.core.Node.selected = property(_get_selected, _set_selected)
static

selected property

Definition at line 324 of file core.py.


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