A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
visualizer.core.Node Class Reference

Node class. More...

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

Public Member Functions

 __init__ (self, visualizer, node_index)
 Initialize function.
 
 add_link (self, link)
 Add link function.
 
 get_position (self)
 Get position function.
 
 has_mobility (self)
 Has mobility function.
 
 on_enter_notify_event (self, view, target, event)
 On Enter event handle.
 
 on_leave_notify_event (self, view, target, event)
 On Leave event handle.
 
 remove_link (self, link)
 Remove link function.
 
 set_color (self, color)
 Set color function.
 
 set_label (self, label)
 Set a label for the node.
 
 set_position (self, x, y)
 Set position function.
 
 set_size (self, size)
 Set size function.
 
 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.
 
 tooltip_query (self, tooltip)
 Query tooltip.
 

Public Attributes

 canvas_item
 canvas item
 
 links
 links
 
 menu
 menu
 
 node_index
 node index
 
 on_enter_notify_event
 on_enter_notify_event function
 
 on_leave_notify_event
 on_leave_notify_event function
 
 svg_align_x
 svg align X
 
 svg_align_y
 svg align Y
 
 svg_item
 svg item
 
 visualizer
 visualier object
 

Protected Member Functions

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

Protected Attributes

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

Properties

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

Static Private Attributes

dict __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
 

Detailed Description

Node class.

Definition at line 91 of file core.py.

Constructor & Destructor Documentation

◆ __init__()

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

Initialize function.

Parameters
selfThe object pointer.
visualizervisualizer object
node_indexnode index

Definition at line 138 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()

visualizer.core.Node._get_highlighted ( self)
protected

Get highlighted function.

Parameters
selfclass object.
Returns
highlighted status

Definition at line 371 of file core.py.

References visualizer.core.Node._highlighted.

◆ _get_selected()

visualizer.core.Node._get_selected ( self)
protected

Get selected function.

Parameters
selfclass object.
Returns
selected status

Definition at line 349 of file core.py.

References visualizer.core.Node._selected.

◆ _set_highlighted()

visualizer.core.Node._set_highlighted ( self,
value )
protected

Set highlighted function.

Parameters
selfclass object.
valueselected value
Returns
none

Definition at line 360 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()

visualizer.core.Node._set_selected ( self,
value )
protected

Set selected function.

Parameters
selfclass object.
valueselected value
Returns
none

Definition at line 338 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()

visualizer.core.Node._update_position ( self)
protected

Update position function.

Parameters
selfclass object.
Returns
none

Definition at line 490 of file core.py.

References grid.ScaleRenderer.get_position(), visualizer.core.Channel.get_position(), visualizer.core.Node.get_position(), visualizer.core.Channel.set_position(), and visualizer.core.Node.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()

visualizer.core.Node._update_svg_position ( self,
x,
y )
protected

Update svg position.

Parameters
selfclass object.
xx position
yy position
Returns
none

Definition at line 226 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()

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

Add link function.

Parameters
selfclass object.
linklink to add.
Returns
none

Definition at line 519 of file core.py.

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

◆ get_position()

visualizer.core.Node.get_position ( self)

Get position function.

Parameters
selfclass object.
Returns
x and y position

Definition at line 478 of file core.py.

References visualizer.core.Channel.canvas_item, visualizer.core.Node.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()

visualizer.core.Node.has_mobility ( self)

◆ on_enter_notify_event()

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 312 of file core.py.

References visualizer.core.Node.highlighted.

◆ on_leave_notify_event()

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 326 of file core.py.

References visualizer.core.Node.highlighted.

◆ remove_link()

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

Remove link function.

Parameters
selfclass object.
linklink to add.
Returns
none

Definition at line 530 of file core.py.

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

◆ set_color()

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

Set color function.

Parameters
selfclass object.
colorcolor to set.
Returns
none

Definition at line 500 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()

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 213 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()

visualizer.core.Node.set_position ( self,
x,
y )

Set position function.

Parameters
selfclass object.
xx position
yy position
Returns
none

Definition at line 438 of file core.py.

References visualizer.core.Node._label_canvas_item, visualizer.core.Node._size, visualizer.core.Node._update_svg_position(), visualizer.core.Channel.canvas_item, visualizer.core.Node.canvas_item, visualizer.core.WiredLink.canvas_item, wifi_intrastructure_link.WifiLink.canvas_item, visualizer.core.Channel.links, visualizer.core.Node.links, visualizer.core.Node.svg_item, interface_statistics.ShowInterfaceStatistics.visualizer, interface_statistics.StatisticsCollector.visualizer, ipv4_routing_table.ShowIpv4RoutingTable.visualizer, olsr.ShowOlsrRoutingTable.visualizer, show_last_packets.ShowLastPackets.visualizer, and visualizer.core.Node.visualizer.

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

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

◆ set_size()

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

Set size function.

Parameters
selfclass object.
sizeselected size
Returns
none

Definition at line 382 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()

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 167 of file core.py.

References visualizer.core.Node._update_appearance(), visualizer.core.Node._update_svg_position(), visualizer.core.Channel.canvas_item, visualizer.core.Node.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, interface_statistics.ShowInterfaceStatistics.visualizer, interface_statistics.StatisticsCollector.visualizer, ipv4_routing_table.ShowIpv4RoutingTable.visualizer, olsr.ShowOlsrRoutingTable.visualizer, show_last_packets.ShowLastPackets.visualizer, and visualizer.core.Node.visualizer.

+ Here is the call graph for this function:

◆ tooltip_query()

Member Data Documentation

◆ __gsignals__

dict 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 134 of file core.py.

◆ _color

visualizer.core.Node._color
protected

color

Definition at line 154 of file core.py.

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

◆ _has_mobility

visualizer.core.Node._has_mobility
protected

has mobility model

Definition at line 151 of file core.py.

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

◆ _highlighted

visualizer.core.Node._highlighted
protected

is highlighted

Definition at line 153 of file core.py.

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

◆ _label

visualizer.core.Node._label
protected

label

Definition at line 162 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
protected

label canvas

Definition at line 163 of file core.py.

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

◆ _selected

visualizer.core.Node._selected
protected

◆ _size

visualizer.core.Node._size
protected

◆ canvas_item

◆ links

◆ menu

visualizer.core.Node.menu

menu

Definition at line 158 of file core.py.

◆ node_index

◆ on_enter_notify_event

visualizer.core.Node.on_enter_notify_event

on_enter_notify_event function

Definition at line 156 of file core.py.

◆ on_leave_notify_event

visualizer.core.Node.on_leave_notify_event

on_leave_notify_event function

Definition at line 157 of file core.py.

◆ svg_align_x

visualizer.core.Node.svg_align_x

svg align X

Definition at line 160 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 161 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 358 of file core.py.


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