HappyDoc Generated Documentation Class: CMO

. / Collaboratory / API.py / CMO 

Collaboratory Management Object.

Only one instance of this needs to be present per extension type. Typically, the class derives from both chimera.EMO and CMO to create a collaboratory-aware Chimera extension. The derived class must call CMO's __init__ method from its own __init__ method. It must also override the "collabCreate" method, which creates and initializes an extension instance from data supplied by the remote side; there must be a SharedState instance associated with the extension instance, and "collabCreate" must return the SharedState instance.

The "data" parameter is always a dictionary whose keys and values correspond to SharedState attribute names and values. Note that the value may contain instances of "CollaboratoryID", which must be converted back to references to real Python object using the Collaboratory utility functions.

Methods   
  __init__ 
__init__ ( self )

Register this type of extension with Collaboratory.

  collabCreate 
collabCreate ( self,  d )

Create an extension instance and start with data. Return the SharedState associated with the extension instance.

Exceptions   

RuntimeError, "no collabCreate method for extension"


This document was automatically generated Thu Nov 09 13:33:54 2006 by HappyDoc version 3.0.a1