SimGrid  3.21
Versatile Simulation of Distributed Systems
List of all members | Public Member Functions | Static Public Attributes | Protected Member Functions
simgrid::s4u::NetZone Class Reference

Detailed Description

Networking Zones.

A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the s4u::Engine).

#include <NetZone.hpp>

Public Member Functions

const std::string & get_name () const
 Retrieves the name of that netzone as a C++ string. More...
 
const char * get_cname () const
 Retrieves the name of that netzone as a C string. More...
 
NetZone * get_father ()
 
std::vector< Host * > get_all_hosts ()
 
int get_host_count ()
 
kernel::routing::NetZoneImpl * get_impl ()
 
std::unordered_map< std::string, std::string > * get_properties ()
 Get the properties assigned to a netzone. More...
 
std::vector< NetZone * > get_children ()
 
const char * get_property (std::string key)
 Retrieve the property value (or nullptr if not set) More...
 
void set_property (std::string key, std::string value)
 
int add_component (kernel::routing::NetPoint *elm)
 
void add_route (kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl *> &link_list, bool symmetrical)
 
void add_bypass_route (kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl *> &link_list, bool symmetrical)
 
NetZone * getFather ()
 
const std::string & getName () const
 
const char * getCname () const
 
void addRoute (kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< simgrid::kernel::resource::LinkImpl *> &link_list, bool symmetrical)
 
void addBypassRoute (kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< simgrid::kernel::resource::LinkImpl *> &link_list, bool symmetrical)
 
std::unordered_map< std::string, std::string > * getProperties ()
 
const char * getProperty (const char *key)
 
void setProperty (const char *key, const char *value)
 
int addComponent (kernel::routing::NetPoint *elm)
 
std::vector< kernel::routing::NetPoint * > getVertices ()
 
int getHostCount ()
 
void getHosts (std::vector< s4u::Host *> *whereto)
 
std::vector< NetZone * > * getChildren ()
 

Static Public Attributes

static simgrid::xbt::signal< void(bool symmetrical, kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl * > &link_list)> on_route_creation
 
static simgrid::xbt::signal< void(NetZone &)> on_creation
 
static simgrid::xbt::signal< void(NetZone &)> on_seal
 

Protected Member Functions

 NetZone (kernel::routing::NetZoneImpl *impl)
 
 ~NetZone ()
 

Constructor & Destructor Documentation

◆ NetZone()

simgrid::s4u::NetZone::NetZone ( kernel::routing::NetZoneImpl *  impl)
explicitprotected

◆ ~NetZone()

simgrid::s4u::NetZone::~NetZone ( )
protected

Member Function Documentation

◆ get_name()

const std::string& simgrid::s4u::NetZone::get_name ( ) const

Retrieves the name of that netzone as a C++ string.

◆ get_cname()

const char* simgrid::s4u::NetZone::get_cname ( ) const

Retrieves the name of that netzone as a C string.

◆ get_father()

NetZone* simgrid::s4u::NetZone::get_father ( )

◆ get_all_hosts()

std::vector<Host*> simgrid::s4u::NetZone::get_all_hosts ( )

◆ get_host_count()

int simgrid::s4u::NetZone::get_host_count ( )

◆ get_impl()

kernel::routing::NetZoneImpl* simgrid::s4u::NetZone::get_impl ( )
inline

◆ get_properties()

std::unordered_map<std::string, std::string>* simgrid::s4u::NetZone::get_properties ( )

Get the properties assigned to a netzone.

◆ get_children()

std::vector<NetZone*> simgrid::s4u::NetZone::get_children ( )

◆ get_property()

const char* simgrid::s4u::NetZone::get_property ( std::string  key)

Retrieve the property value (or nullptr if not set)

◆ set_property()

void simgrid::s4u::NetZone::set_property ( std::string  key,
std::string  value 
)

◆ add_component()

int simgrid::s4u::NetZone::add_component ( kernel::routing::NetPoint *  elm)

◆ add_route()

void simgrid::s4u::NetZone::add_route ( kernel::routing::NetPoint *  src,
kernel::routing::NetPoint *  dst,
kernel::routing::NetPoint *  gw_src,
kernel::routing::NetPoint *  gw_dst,
std::vector< kernel::resource::LinkImpl *> &  link_list,
bool  symmetrical 
)

◆ add_bypass_route()

void simgrid::s4u::NetZone::add_bypass_route ( kernel::routing::NetPoint *  src,
kernel::routing::NetPoint *  dst,
kernel::routing::NetPoint *  gw_src,
kernel::routing::NetPoint *  gw_dst,
std::vector< kernel::resource::LinkImpl *> &  link_list,
bool  symmetrical 
)

◆ getFather()

NetZone* simgrid::s4u::NetZone::getFather ( )
inline
Deprecated:
NetZone::get_father()

◆ getName()

const std::string& simgrid::s4u::NetZone::getName ( ) const
inline
Deprecated:
NetZone::get_name()

◆ getCname()

const char* simgrid::s4u::NetZone::getCname ( ) const
inline
Deprecated:
NetZone::get_cname()

◆ addRoute()

void simgrid::s4u::NetZone::addRoute ( kernel::routing::NetPoint *  src,
kernel::routing::NetPoint *  dst,
kernel::routing::NetPoint *  gw_src,
kernel::routing::NetPoint *  gw_dst,
std::vector< simgrid::kernel::resource::LinkImpl *> &  link_list,
bool  symmetrical 
)
inline
Deprecated:
NetZone::add_route()

◆ addBypassRoute()

void simgrid::s4u::NetZone::addBypassRoute ( kernel::routing::NetPoint *  src,
kernel::routing::NetPoint *  dst,
kernel::routing::NetPoint *  gw_src,
kernel::routing::NetPoint *  gw_dst,
std::vector< simgrid::kernel::resource::LinkImpl *> &  link_list,
bool  symmetrical 
)
inline
Deprecated:
NetZone::add_bypass_route()

◆ getProperties()

std::unordered_map<std::string, std::string>* simgrid::s4u::NetZone::getProperties ( )
inline
Deprecated:
NetZone::get_properties()

◆ getProperty()

const char* simgrid::s4u::NetZone::getProperty ( const char *  key)
inline
Deprecated:
NetZone::get_property()

◆ setProperty()

void simgrid::s4u::NetZone::setProperty ( const char *  key,
const char *  value 
)
inline
Deprecated:
NetZone::set_property()

◆ addComponent()

int simgrid::s4u::NetZone::addComponent ( kernel::routing::NetPoint *  elm)
inline
Deprecated:
NetZone::add_component()

◆ getVertices()

std::vector<kernel::routing::NetPoint*> simgrid::s4u::NetZone::getVertices ( )
Deprecated:
NetZone::get_vertices()

◆ getHostCount()

int simgrid::s4u::NetZone::getHostCount ( )
inline
Deprecated:
NetZone::get_host_count()

◆ getHosts()

void simgrid::s4u::NetZone::getHosts ( std::vector< s4u::Host *> *  whereto)
Deprecated:
NetZone::get_all_hosts()

◆ getChildren()

std::vector<NetZone*>* simgrid::s4u::NetZone::getChildren ( )
inline
Deprecated:
NetZone::get_children()

Member Data Documentation

◆ on_route_creation

simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst, std::vector<kernel::resource::LinkImpl*>& link_list)> simgrid::s4u::NetZone::on_route_creation
static

◆ on_creation

simgrid::xbt::signal<void(NetZone&)> simgrid::s4u::NetZone::on_creation
static

◆ on_seal

simgrid::xbt::signal<void(NetZone&)> simgrid::s4u::NetZone::on_seal
static
The documentation for this class was generated from the following file: