Package MDSplus :: Module tree :: Class CachedTree
[frames | no frames]

Type CachedTree

object --+    
         |    
      Tree --+
             |
            CachedTree


MDSplus tree with cached data updating
Method Summary
  __init__(self, tree, shot)
Initialize CachedTree instance.
CachedTreeNode getCachedNode(self, name)
Locate node in tree.
None initialize(cachesize, shared)
Configure the cachesize and shared settings. (Static method)
None synch()
Wait for all pending write operations in WRITE_THOUGH policy (Static method)
    Inherited from Tree
None __del__(self)
Delete Tree instance
various __getattr__(self, name)
Implements value=tree.attribute
None __setattr__(self, name, value)
Implements tree.attribute=value
str __str__(self)
Return string representation
TreeNode addDevice(self, nodename, model)
Add a device to the tree of the specified device model type.
TreeNode addNode(self, nodename, usage)
Add a node to the tree.
None createPulse(self, shot)
Create pulse.
None deleteNode(self, wild)
Delete nodes (and all their descendants) from the tree.
None deletePulse(self, shot)
Delete pulse.
  doMethod(nid, method)
For internal use only. (Static method)
None edit(self)
Open tree for editing.
ndarray findTags(self, wild)
Find tags matching wildcard expression
Tree getActiveTree()
Get active tree. (Static method)
int getCurrent(treename)
Return current shot for specificed treename (Static method)
TreeNode getDefault(self)
Return current default TreeNode
TreeNode getNode(self, name)
Locate node in tree.
TreeNodeArray getNodeWild(self, name, *usage)
Find nodes in tree using a wildcard specification.
str getVersionDate()
Get date used for retrieving versions (Static method)
bool isModified(self)
Check to see if tree is open for edit and has been modified
bool isOpenForEdit(self)
Check to see if tree is open for edit
bool isReadOnly(self)
Check to see if tree was opened readonly
  lock(cls)
Internal use only. (Class method)
None quit(self)
Close edit session discarding node structure and tag changes.
None removeTag(self, tag)
Remove a tagname from the tree
  restoreContext(self)
Internal use only.
Tree setActiveTree(cls, tree)
Set active tree. (Class method)
  setCurrent(treename, shot)
Set current shot for specified treename (Static method)
TreeNode setDefault(self, node)
Set current default TreeNode.
None setTimeContext(begin, end, delta)
Set time context for retrieving segmented records (Static method)
None setVersionDate(date)
Set date for retrieving versions if versioning is enabled in tree. (Static method)
None setVersionsInModel(self, flag)
Enable/Disable versions in model
None setVersionsInPulse(self, flag)
Enable/Disable versions in pulse
  unlock(cls)
Internal use only. (Class method)
  usePrivateCtx(cls, on)
(Class method)
bool versionsInModelEnabled(self)
Check to see if versions in the model are enabled
bool versionsInPulseEnabled(self)
Check to see if versions in the pulse are enabled
None write(self)
Write out edited tree.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)

Class Variable Summary
bool initialized = False

Instance Method Details

__init__(self, tree, shot)
(Constructor)

Initialize CachedTree instance.
Parameters:
tree - Tree name
           (type=str)
shot - Shot number
           (type=int)
Overrides:
MDSplus.tree.Tree.__init__

getCachedNode(self, name)

Locate node in tree. Returns CachedTreeNode if found. Use double backslashes in node names.
Parameters:
name - Relative or absolute tree path
           (type=str)
Returns:
node found
           (type=CachedTreeNode)

Static Method Details

initialize(cachesize, shared)

Configure the cachesize and shared settings. Must be called before creating any instance of CachedTree.
Parameters:
cachesize - Size of cache
           (type=int)
shared - Flag indicating whether cache is shared or not.
           (type=bool)
Returns:
None

synch()

Wait for all pending write operations in WRITE_THOUGH policy
Returns:
None

Class Variable Details

initialized

Type:
bool
Value:
False                                                                  

Generated by Epydoc 2.1 on Wed Aug 18 13:35:32 2010 http://epydoc.sf.net