gui.node.node.Node Class Reference

Abstract node of the tree. More...

Inheritance diagram for gui.node.node.Node:

Public Member Functions
	__init__ (self, DataPointPath path)
str	short_name (self)
	Returns the last component of the datapoint path.
bool	is_root (self)
	Returns True if this is the root node of the tree and False otherwise.
Any	get_value (self)
	Return the node's current value.
	set_value (self, Any new_value, *args, **kwargs)
	Set the node's value.
dict	get_metadata (self, bool except_internals=False)
	Return the node's metadata, optionally excluding internal metadata.
	set_metadata (self, dict new_metadata, *args, **kwargs)
	Set the node's metadata.
	update_metadata (self, str key, value, *args, **kwargs)
	Update one metadata entry with the given key and value.
bool	is_leaf (self)
	Return whether the node is a leaf node.
bool	can_fetch_more (self)
	Return whether additional data can be fetched for the node.
bool	is_requested (self)
	Return whether the node has any part in requested state.
	mark_ready (self)
	Set the node's data to ready state.

Public Attributes
	path = path
	old_path = None
	parent = None
	children = None

Static Protected Attributes
dict	_internal_metadata_keys

Detailed Description

Abstract node of the tree.

Constructor & Destructor Documentation

__init__()

gui.node.node.Node.__init__	(		self,
		DataPointPath	path )

Member Function Documentation

can_fetch_more()

bool gui.node.node.Node.can_fetch_more

(

self

)

Return whether additional data can be fetched for the node.

get_metadata()

dict gui.node.node.Node.get_metadata	(		self,
		bool	except_internals = False )

Return the node's metadata, optionally excluding internal metadata.

get_value()

Any gui.node.node.Node.get_value

(

self

)

Return the node's current value.

is_leaf()

bool gui.node.node.Node.is_leaf

(

self

)

Return whether the node is a leaf node.

is_requested()

bool gui.node.node.Node.is_requested

(

self

)

Return whether the node has any part in requested state.

is_root()

bool gui.node.node.Node.is_root

(

self

)

Returns True if this is the root node of the tree and False otherwise.

mark_ready()

gui.node.node.Node.mark_ready

(

self

)

Set the node's data to ready state.

set_metadata()

gui.node.node.Node.set_metadata	(		self,
		dict	new_metadata,
		*	args,
		**	kwargs )

Set the node's metadata.

set_value()

gui.node.node.Node.set_value	(		self,
		Any	new_value,
		*	args,
		**	kwargs )

Set the node's value.

short_name()

str gui.node.node.Node.short_name

(

self

)

Returns the last component of the datapoint path.

update_metadata()

gui.node.node.Node.update_metadata	(		self,
		str	key,
			value,
		*	args,
		**	kwargs )

Update one metadata entry with the given key and value.

Member Data Documentation

_internal_metadata_keys

dict gui.node.node.Node._internal_metadata_keys

staticprotected

children

gui.node.node.Node.children = None

old_path

gui.node.node.Node.old_path = None

parent

gui.node.node.Node.parent = None

path

gui.node.node.Node.path = path

---

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

• clients/configTool/src/rtctk/configtool/gui/node/node.py