Home       Trees       Indices       Help   
Package Ganga :: Package GPIDev :: Package Lib :: Package JobTree :: Module JobTree' :: Class JobTree :: Class _proxyClass
[hide private]
[frames] | no frames]

Class _proxyClass

source code

    object --+    
             |    
GPIProxyObject --+
                 |
                Lib.JobTree.JobTree'.JobTree._proxyClass

The jobtree object in Ganga gives you the possibility to organise jobs
    in a directory structure. Jobs are stored in the jobtree by their index
    and you can think of it as a softlink.
    This also means that jobs can be placed in several folders at the same time.
    If you remove a job from the registry the references in the jobtreee will
    also automatically disappear (because registry calls cleanlinks() method).
    The jobtree is persisted in between Ganga sessions.
    

Properties:

     name (simple property, default='',comparable)
Nested Classes [hide private]
  _impl
This is a Ganga.GPI.JobTree implementation class.
Instance Methods [hide private]
 
__eq__(self, x)
Equality operator (==), compare the JobTree properties which are declared as [comparable].		 source code
 
__init__(self, *args, **kwds)
GPI JobTree object constructor: JobTree() : create jobtree with default settings; JobTree(j) : make a copy of j; JobTree(j,x=a,...): make a copy of j and set property 'x' to a, etc..		 source code
 
__ne__(self, x)
Non-equality operator (!=).		 source code
 
__repr__(self)
Return an short representation of JobTree object.		 source code
 
__setattr__(self, x, v)
Set a property of JobTree with consistency and safety checks.		 source code
 
__str__(...)
str(x)		 source code
 
_display(...) source code
 
add(...)
Adds job to the job tree into the current folder.		 source code
 
cd(...)
Changes current directory.		 source code
 
cleanlinks(...)
Removes all references for the jobs not present in the registry.		 source code
 
copy(...) source code
 
exists(...)
Checks wether the path exists or not.		 source code
 
find(...)
For a job with given id tries to find all references in the job tree.		 source code
 
getjobs(...)
Gives list of all jobs (objects) referenced in current folder or folder in the path if the latter is provided.		 source code
 
isdir(...)
Checks wether the path points to a folder or not.		 source code
 
listdirs(...)
Lists all subfolders in current folder or folder in the path if the latter is provided.		 source code
 
listjobs(...)
Lists ids of all jobs in current folder or folder in the path if the latter is provided.		 source code
 
ls(...)
Lists content of current folder or folder in the path if the latter is provided.		 source code
 
mkdir(...)
Makes a folder.		 source code
 
printtree(...)
Prints content of the job tree in a well formatted way.		 source code
 
pwd(...)
Returns current folder		 source code
 
rm(...)
Removes folder or job in the path.		 source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __sizeof__, __subclasshook__

Class Variables [hide private]
  name = <Ganga.GPIDev.Base.Proxy.ProxyDataDescriptor object at ...
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args, **kwds)
(Constructor)

source code 

GPI JobTree object constructor: JobTree() : create jobtree with default settings; JobTree(j) : make a copy of j; JobTree(j,x=a,...): make a copy of j and set property 'x' to a, etc..

Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

Return an short representation of JobTree object.

Overrides: object.__repr__

__setattr__(self, x, v)

source code 

Set a property of JobTree with consistency and safety checks. Setting a [protected] or a unexisting property raises AttributeError.

Overrides: object.__setattr__

__str__(...)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

add(...)

source code 

Adds job to the job tree into the current folder. If path to a folder is provided as a parameter than adds job to that folder.

cd(...)

source code 

Changes current directory. If path is not provided, than switches to the root folder.

cleanlinks(...)

source code 

Removes all references for the jobs not present in the registry. Normally you don't need to call this method since it is called automatically whenever job is deleted from the registry.

find(...)

source code 

For a job with given id tries to find all references in the job tree. The return value is a list of found paths.

ls(...)

source code 

Lists content of current folder or folder in the path if the latter is provided. The return value is a dictionary of the format {'folders':[<list of folders>], 'jobs':[<list of job ids>]}.

mkdir(...)

source code 

Makes a folder. If any folders in the path are missing they will be created as well.

rm(...)

source code 

Removes folder or job in the path. To clean all use /* as a path.


Class Variable Details [hide private]

name

Value:
<Ganga.GPIDev.Base.Proxy.ProxyDataDescriptor object at 0x1eb2bd0>

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Mon Jun 25 10:35:19 2012 http://epydoc.sourceforge.net