xroad.system.System Class Reference

System class. More...

Inheritance diagram for xroad.system.System:

Collaboration diagram for xroad.system.System:

Classes
class	SystemCtypes

Public Member Functions
def	__init__ (self, out_of_system=False, node=None)
def	name (self)
def	root_dir (self)
def	role (self)
def	role (self, val)
def	get_by_name (self, node_name)
	find NodeData by node name More...
def	get_by_id (self, id)
	find NodeData by node id More...
def	get_by_pid (self, node_pid)
	find NodeData by pid More...
def	get_node (self, node)
	return node data by name or id More...
def	nodes (self)
	iterate via nodes More...
def	read_config (self, ndata)
	read configuration More...
def	clone (self, node, new_node)
	clone node More...
def	delete (self, node)
	delete node More...
def	rename (self, node, new_name)
	rename node More...
def	move (self, node, new_group)
	move node More...

Detailed Description

System class.

Main nodes registration place

Member Function Documentation

clone()

def xroad.system.System.clone	(		self,
			node,
			new_node
	)

clone node

Parameters

[in]	node	- node to clone
[in]	new_node	- new node name

Returns

new node id

delete()

def xroad.system.System.delete	(		self,
			node
	)

delete node

Parameters

[in]

node

- node to delete

get_by_id()

def xroad.system.System.get_by_id	(		self,
			id
	)

find NodeData by node id

Parameters

[in]

id

- node id return NodeData or None

get_by_name()

def xroad.system.System.get_by_name	(		self,
			node_name
	)

find NodeData by node name

Parameters

[in]

node_name

- node name

Returns

NodeData or None

get_by_pid()

def xroad.system.System.get_by_pid	(		self,
			node_pid
	)

find NodeData by pid

Parameters

[in]

node_pid

- process pid

Returns

NodeData or None

get_node()

def xroad.system.System.get_node	(		self,
			node
	)

return node data by name or id

Parameters

[in]

node

- node name or id

Returns

NodeData

move()

def xroad.system.System.move	(		self,
			node,
			new_group
	)

move node

Parameters

[in]	ndata	- node to move (NodeData)
[in]	new_name	- new node group

Returns

True - moved

nodes()

def xroad.system.System.nodes

(

self

)

iterate via nodes

Returns

NodeData or None

read_config()

def xroad.system.System.read_config	(		self,
			ndata
	)

read configuration

Parameters

[in]

ndata

- node data

Returns

config

rename()

def xroad.system.System.rename	(		self,
			node,
			new_name
	)

rename node

Parameters

[in]	ndata	- node to rename (NodeData)
[in]	new_name	- new node name

Returns

True - renamed

---

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

• /home/dmitryme/dev/xroad/release/sdk/python/xroad/system.py