diff -r 7685cec9fd3c -r f2ddfa555b0f doc/api/python/ccm.AbstractSession-class.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/api/python/ccm.AbstractSession-class.html Fri Sep 11 11:54:49 2009 +0100 @@ -0,0 +1,610 @@ + + + + + ccm.AbstractSession + + + + + + + + + + + + + + + + + + + + +
   Trees      Indices      Help   
+ + + + + +
+ + Package ccm :: + Class AbstractSession + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class AbstractSession

source code

+
+object --+
+         |
+        AbstractSession
+
+ +
+

An abstract Synergy session.

+

Must be overridden to implement either a single session or +multiple session handling.



+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + username, + engine, + dbpath, + ccm_addr)
+ x.__init__(...) initializes x; see x.__class__.__doc__ for signature		 + source code + +
+ +
+   + + + + + + +
addr(self)
+ Returns the Synergy session id.		 + source code + +
+ +
+   + + + + + + +
database(self) + source code + +
+ +
+   + + + + + + +
__find_dbpath(self)
+ retrieve the database path from current session status.		 + source code + +
+ +
+   + + + + + + +
execute(self, + _, + result=None)
+ Abstract function that should implement the execution of ccm command +line call.		 + source code + +
+ +
+   + + + + + + +
create(self, + fpn)
+ Object factory, this is the toolkit entry point to create objects from +four part names.		 + source code + +
+ +
+   + + + + + + +
get_workarea_info(self, + dir_)
+ Return a dictionary containing workarea info from directory dir.		 + source code + +
+ +
+   + + + + + + +
_get_role(self) + source code + +
+ +
+   + + + + + + +
_set_role_internal(self, + role)
+ method to be override by child class else property accession is not working properly.		 + source code + +
+ +
+   + + + + + + +
_set_role(self, + role) + source code + +
+ +
+   + + + + + + +
_get_home(self) + source code + +
+ +
+   + + + + + + +
_set_home(self, + home) + source code + +
+ +
+   + + + + + + +
close(self) + source code + +
+ +
+   + + + + + + +
__str__(self)
+ str(x)		 + source code + +
+ +
+   + + + + + + +
__repr__(self)
+ repr(x)		 + source code + +
+ +
+   + + + + + + +
__del__(self) + source code + +
+ +
+   + + + + + + +
purposes(self, + role=None)
+ Returns available purposes.		 + source code + +
+ +
+

Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __setattr__ +

+
+ + + + + + + + + + + + +
+ + + + + +
Class Variables[hide private]
+
+   + + role = property(fget= _get_role, fset= _set_role) +
+   + + home = property(_get_home, _set_home) +
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + username, + engine, + dbpath, + ccm_addr) +
(Constructor) +

+ 		source code  +
+ + x.__init__(...) initializes x; see x.__class__.__doc__ for signature +
+
Overrides: + object.__init__ +
(inherited documentation)
+ +
+
+
+ +
+ +
+ + +
+

create(self, + fpn) +

+ 		source code  +
+ + Object factory, this is the toolkit entry point to create objects from +four part names. Objects are stored into a dictionary, so you have +only one wrapper per synergy object. +
+
+
+
+ +
+ +
+ + +
+

__str__(self) +
(Informal representation operator) +

+ 		source code  +
+ + str(x) +
+
Overrides: + object.__str__ +
(inherited documentation)
+ +
+
+
+ +
+ +
+ + +
+

__repr__(self) +
(Representation operator) +

+ 		source code  +
+ + repr(x) +
+
Overrides: + object.__repr__ +
(inherited documentation)
+ +
+
+
+
+ + + + + + + + + + + + + + + +
   Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009 + + http://epydoc.sourceforge.net +
+ + + + +