rtctree.manager.Manager Class Reference

Manager node object. More...

Inheritance diagram for rtctree.manager.Manager:

Public Member Functions
def	__init__ (self, name=None, parent=None, obj=None, args, kwargs)
def	components (self)
def	configuration (self)
def	create_component (self, module_name)
	Module and component management. More...
def	delete_component (self, instance_name)
def	factory_profiles (self)
def	fork (self)
	Undocumented functions. More...
def	is_directory (self)
	Node functionality. More...
def	is_manager (self)
def	is_master (self)
def	load_module (self, path, init_func)
def	loadable_modules (self)
def	loaded_modules (self)
def	masters (self)
def	object (self)
def	profile (self)
def	restart (self)
def	set_config_parameter (self, param, value)
	Manager configuration. More...
def	shutdown (self)
def	slaves (self)
def	unload_module (self, path)
Public Member Functions inherited from rtctree.node.TreeNode
def	__init__ (self, name=None, parent=None, children=None, filter=[], dynamic=False, args, kwargs)
def	__str__ (self)
def	add_callback (self, event, cb, args=None)
def	children (self)
def	children_names (self)
def	depth (self)
def	dynamic (self)
def	dynamic (self, dynamic)
def	full_path (self)
def	full_path_str (self)
def	get_node (self, path)
def	has_path (self, path)
def	is_child (self, other_node)
def	is_component (self)
def	is_directory (self)
def	is_manager (self)
def	is_nameserver (self)
def	is_parent (self, other_node)
def	is_unknown (self)
def	is_zombie (self)
def	iterate (self, func, args=None, filter=[])
def	name (self)
def	nameserver (self)
def	orb (self)
def	parent (self)
def	parent (self, new_parent)
def	parent_name (self)
def	rem_callback (self, event, cb)
def	remove_child (self, child)
def	root (self)

Public Attributes
	parent

Private Member Functions
def	_add_master (self, new_master)
	Internal functions. More...
def	_add_slave (self, new_slave)
def	_parse (self)
def	_parse_children (self)
def	_parse_component_children (self)
def	_parse_manager_children (self)
def	_remove_master (self, master)
def	_remove_slave (self, slave)
def	_set_parent (self, new_parent)

Private Attributes
	_components
	_configuration
	_factory_profiles
	_loadable_modules
	_loaded_modules
	_masters
	_obj
	_profile
	_slaves

Detailed Description

Manager node object.

Node representing a manager on a name server.

Manager nodes can occur below name server and directory nodes. They may
store child components and child managers. They can be used to add and
remove new components and managers to the tree at run time.

Definition at line 42 of file manager.py.

Constructor & Destructor Documentation

def rtctree.manager.Manager.__init__	(		self,
			name = None,
			parent = None,
			obj = None,
			args,
			kwargs
	)

Constructor. Calls the TreeNode constructor.

Definition at line 50 of file manager.py.

Member Function Documentation

def rtctree.manager.Manager._add_master (   self,   new_master  )

private

Internal functions.

Definition at line 291 of file manager.py.

def rtctree.manager.Manager._add_slave (   self,   new_slave  )

private

Definition at line 298 of file manager.py.

def rtctree.manager.Manager._parse (   self )

private

Definition at line 307 of file manager.py.

def rtctree.manager.Manager._parse_children (   self )

private

Definition at line 320 of file manager.py.

def rtctree.manager.Manager._parse_component_children (   self )

private

Definition at line 326 of file manager.py.

def rtctree.manager.Manager._parse_manager_children (   self )

private

Definition at line 343 of file manager.py.

def rtctree.manager.Manager._remove_master (   self,   master  )

private

Definition at line 372 of file manager.py.

def rtctree.manager.Manager._remove_slave (   self,   slave  )

private

Definition at line 379 of file manager.py.

def rtctree.manager.Manager._set_parent (   self,   new_parent  )

private

Definition at line 387 of file manager.py.

def rtctree.manager.Manager.components

(

self

)

The list of components in this manager, if any.

This information can also be found by listing the children of this node
that are of type @ref Component. That method is more useful as it returns
the tree entries for the components.

Definition at line 137 of file manager.py.

def rtctree.manager.Manager.configuration

(

self

)

The configuration dictionary of the manager.

Definition at line 178 of file manager.py.

def rtctree.manager.Manager.create_component	(		self,
			module_name
	)

Module and component management.

Create a component out of a loaded module.

Turns a previously-loaded shared module into a component in the
manager. This will invalidate any objects that are children of this
node.

The @ref module_name argument can contain options that set various
properties of the new component. These must be appended to the module
name, prefixed by a question mark for each property, in key=value
format. For example, to change the instance name of the new component,
append '?instance_name=new_name' to the module name.

@param module_name Name of the module to turn into a component.
@raises FailedToCreateComponentError

Definition at line 60 of file manager.py.

def rtctree.manager.Manager.delete_component	(		self,
			instance_name
	)

Delete a component.

Deletes the component specified by @ref instance_name from the manager.
This will invalidate any objects that are children of this node.

@param instance_name The instance name of the component to delete.
@raises FailedToDeleteComponentError

Definition at line 84 of file manager.py.

def rtctree.manager.Manager.factory_profiles

(

self

)

The factory profiles of all loaded modules.

Definition at line 151 of file manager.py.

def rtctree.manager.Manager.fork

(

self

)

Undocumented functions.

Fork the manager.

Definition at line 197 of file manager.py.

def rtctree.manager.Manager.is_directory

(

self

)

Node functionality.

Is this node a directory?

Definition at line 216 of file manager.py.

def rtctree.manager.Manager.is_manager

(

self

)

Is this node a manager?

Definition at line 221 of file manager.py.

def rtctree.manager.Manager.is_master

(

self

)

Is this manager node a master manager?

Master managers have a direct presence on the name server. Slave
managers are only present as children of other managers.

Definition at line 233 of file manager.py.

def rtctree.manager.Manager.load_module	(		self,
			path,
			init_func
	)

Load a shared library.

Call this function to load a shared library (DLL file under Windows,
shared object under UNIX) into the manager.

@param path The path to the shared library.
@param init_func The name entry function in the library.
@raises FailedToLoadModuleError

Definition at line 101 of file manager.py.

def rtctree.manager.Manager.loadable_modules

(

self

)

The list of loadable module profile dictionaries.

Definition at line 244 of file manager.py.

def rtctree.manager.Manager.loaded_modules

(

self

)

The list of loaded module profile dictionaries.

Definition at line 254 of file manager.py.

def rtctree.manager.Manager.masters

(

self

)

The list of master managers of this manager, if any.

If this manager is a master, this list will be empty.

Definition at line 264 of file manager.py.

def rtctree.manager.Manager.object

(

self

)

The RTM::Manager object that this node contains.

Definition at line 227 of file manager.py.

def rtctree.manager.Manager.profile

(

self

)

The manager's profile.

Definition at line 186 of file manager.py.

def rtctree.manager.Manager.restart

(

self

)

Restart the manager.

Definition at line 207 of file manager.py.

def rtctree.manager.Manager.set_config_parameter	(		self,
			param,
			value
	)

Manager configuration.

Set a configuration parameter of the manager.

@param The parameter to set.
@value The new value for the parameter.
@raises FailedToSetConfigurationError

Definition at line 163 of file manager.py.

def rtctree.manager.Manager.shutdown

(

self

)

Shut down the manager.

Definition at line 202 of file manager.py.

def rtctree.manager.Manager.slaves

(

self

)

The list of slave managers of this manager, if any.

This information can also be found by listing the children of this node
that are of type @ref Manager.

Definition at line 276 of file manager.py.

def rtctree.manager.Manager.unload_module	(		self,
			path
	)

Unload a loaded shared library.

Call this function to remove a shared library (e.g. a component) that
was previously loaded.

@param path The path to the shared library.
@raises FailedToUnloadModuleError

Definition at line 122 of file manager.py.

Member Data Documentation

rtctree.manager.Manager._components

private

Definition at line 147 of file manager.py.

rtctree.manager.Manager._configuration

private

Definition at line 175 of file manager.py.

rtctree.manager.Manager._factory_profiles

private

Definition at line 155 of file manager.py.

rtctree.manager.Manager._loadable_modules

private

Definition at line 248 of file manager.py.

rtctree.manager.Manager._loaded_modules

private

Definition at line 258 of file manager.py.

rtctree.manager.Manager._masters

private

Definition at line 316 of file manager.py.

rtctree.manager.Manager._obj

private

Definition at line 54 of file manager.py.

rtctree.manager.Manager._profile

private

Definition at line 191 of file manager.py.

rtctree.manager.Manager._slaves

private

Definition at line 285 of file manager.py.

rtctree.manager.Manager.parent

Definition at line 399 of file manager.py.

---

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

• manager.py