g4ds.communicationmanager.ProtocolManager

Package g4ds :: Module communicationmanager :: Class ProtocolManager

[show private | hide private]

Class ProtocolManager

Maintains a list of protocols.

Method Summary
	`__init__(self, loadFromDatabase)` Initialises the manager with the subjacent database.
	`__str__(self)` Some basic information about the object
	`addProtocol(self, protocol, persistent)` Add one protocol to the manager.
	`getProtocol(self, protocolId)` Returns the protocol instance for the given protocol id.
	`getProtocolByNameAndInsert(self, protocolname)` Returns the protocol with given protocol name.
`List` of `Protocol`	`getProtocols(self)` Returns a list of all saved protocols.

Instance Variable Summary
`communicationmanager_db.CommDB`	`_comm_db`: Communication Database Connector
`Boolean`	`_dbconnected`: Indicates, whether the manager is connected to a database; hence whether the changes shall be written through
`Dict` (`String` \| `Protocol`)	`_protocols`: Dictionary, maintaining the protocols - accessable by its id

Method Details

init(self, loadFromDatabase=1)
(Constructor)

Initialises the manager with the subjacent database.

Parameters:: loadFromDatabase - Indicates, whether the manager shall be initialised from the database backend
(type=Boolean)

str(self)
(Informal representation operator)

Some basic information about the object

addProtocol(self, protocol, persistent=1)

Add one protocol to the manager.

Parameters:: protocol - Protocol to be added
(type=Protocol); persistent - Indicates, whether the protocol shall be written through to the database
(type=Boolean)

getProtocol(self, protocolId)

Returns the protocol instance for the given protocol id.

getProtocolByNameAndInsert(self, protocolname)

Returns the protocol with given protocol name.

If the protocol is not yet in the manager it will be created.

getProtocols(self)

Returns a list of all saved protocols.

Returns:: List of all protocols
(type=List of Protocol)

Instance Variable Details

_comm_db

Communication Database Connector

Type:: communicationmanager_db.CommDB

_dbconnected

Indicates, whether the manager is connected to a database; hence whether the changes shall be written through

Type:: Boolean

_protocols

Dictionary, maintaining the protocols - accessable by its id

Type:: Dict (String | Protocol)

Generated by Epydoc 2.0 on Sat Oct 22 22:52:47 2005

http://epydoc.sf.net