Package MDSplus :: Module treenode :: Class CachedTreeNode
[frames | no frames]

Type CachedTreeNode

object --+        
         |        
      Data --+    
             |    
      TreeNode --+
                 |
                CachedTreeNode


Node belonging to a cached tree
Method Summary
None beginSegment(self, start, end, dimension, initialValueArray, idx)
Begin a record segment
  flush(self)
  getCachePolicy(self)
return cache policy for this node
  getData(self)
Return data
  getNumSegments(self)
Get number of segments
  getSegmentEnd(self, idx)
return end of segment
  getSegmentStart(self, idx)
return start of segment
  putData(self, value)
  putLastRow(self, bufsize, array, timestamp)
None putRow(self, bufsize, array, timestamp)
Load a timestamped segment row
None putSegment(self, data, idx)
Load a segment in a node
  putTimestampedSegment(self, array, timestampArray)
Put timestamped segment
  setCachePolicy(self, policy)
set cache policy for this node
  updateSegment(self, start, end, dim, idx)
Update a segment
    Inherited from TreeNode
  __init__(self, n, tree)
Initialze TreeNode
various __getattr__(self, name)
Implements value=node.attribute
None __setattr__(self, name, value)
Implements node.attribute=value
  __str__(self)
Convert TreeNode to string.
TreeNode addDevice(self, name, model)
Add device descendant.
TreeNode addNode(self, name, usage)
Add node
None addTag(self, tag)
Add a tagname to this node
None beginTimestampedSegment(self, array, idx)
Allocate space for a timestamped segment
Bool compare(self, value)
Returns True if this node contains the same data as specified in the value argument
bool containsVersions(self)
Return true if this node contains data versions
None delete(self)
Delete this node from the tree
None deleteData(self)
Delete data from this node
None doMethod(self, method, arg)
Execute method on conglomerate element
TreeNode getBrother(self)
Return sibling of this node
TreeNode getChild(self)
Return first child of this node.
TreeNodeArray getChildren(self)
Return TreeNodeArray of children nodes.
String getClass(self)
Return MDSplus class name of this node
int getCompressedLength(self)
Return compressed data length of this node
Int32 getConglomerateElt(self)
Return index of this node in a conglomerate
TreeNodeArray getConglomerateNodes(self)
Return TreeNodeArray of conglomerate elements
Int32 getDepth(self)
Get depth of this node in the tree
TreeNodeArray getDescendants(self)
Return TreeNodeArray of first level descendants (children and members).
String getDtype(self)
Return the name of the data type stored in this node
String getFullPath(self)
Return full path of this node
int getLength(self)
Return uncompressed data length of this node
str getLocalPath(self)
Return path relative to top of local tree
str getLocalTree(self)
Return tree containing this node
TreeNode getMember(self)
Return first member node
TreeNodeArray getMembers(self)
Return TreeNodeArray of this nodes members
String getMinPath(self)
Return shortest path string for this node
int getNid(self)
Return node index
TreeNode getNode(self, path)
Return tree node where path is relative to this node
String getNodeName(self)
Return node name
TreeNodeArray getNodeWild(self, path)
Return tree nodes where path is relative to this node
Int32 getNumChildren(self)
Return number of children nodes.
int getNumDescendants(self)
Return number of first level descendants (children and members)
Int32 getNumElts(self)
Return number of nodes in this conglomerate
int getNumMembers(self)
Return number of members
String getOriginalPartName(self)
Return the original part name of node in conglomerate
int getOwnerId(self)
Get id/gid value of account which wrote data to this node
TreeNode getParent(self)
Return parent of this node
String getPath(self)
Return path of this node
Signal | None getSegment(self, idx)
Return segment
Dimension getSegmentDim(self, idx)
Return dimension of segment
int getStatus(self)
Return action completion status
ndarray getTags(self)
Return tags of this node
Uint64 getTimeInserted(self)
Return time data was written
Tree getTree(self)
Return Tree associated with this node
str getUsage(self)
Return usage of this node
bool isChild(self)
Return true if this is a child node
bool isCompressible(self)
Return true if node contains data which can be compressed
bool isCompressOnPut(self)
Return true if node is set to compress on put
bool isDoNotCompress(self)
Return true of compression is disabled for this node
bool isEssential(self)
Return true if successful action completion is essential
bool isIncludedInPulse(self)
Return true if this subtree is to be included in pulse file
bool isMember(self)
Return true if this is a member node
bool isNoWriteModel(self)
Return true if data storage to model is disabled for this node
bool isNoWriteShot(self)
Return true if data storage to pulse file is disabled for this node
bool isOn(self)
Return True if node is turned on, False if not.
bool isSegmented(self)
Return true if this node contains segmented records
bool isSetup(self)
Return true if data is setup information.
bool isWriteOnce(self)
Return true if node is set write once
None makeTimestampedSegment(self, timestampArray, array, idx, rows_filled)
Load a timestamped segment
None move(self, parent, newname)
Move node to another location in the tree and optionally rename the node
None removeTag(self, tag)
Remove a tagname from this node
None rename(self, newname)
Rename node this node
None restoreContext(self)
Restore tree context.
None setCompressOnPut(self, flag)
Set compress on put state of this node
None setDoNotCompress(self, flag)
Set do not compress state of this node
None setEssential(self, flag)
Set essential state of this node
None setIncludedInPulse(self, flag)
Set include in pulse state of this node
None setNoWriteModel(self, flag)
Set no write model state for this node
None setNoWriteShot(self, flag)
Set no write shot state for this node
None setOn(self, flag)
Turn node on or off
None setSubtree(self, flag)
Enable/Disable node as a subtree
None setTree(self, tree)
Set Tree associated with this node
None setUsage(self, usage)
Set the usage of a node
None setWriteOnce(self, flag)
Set write once state of node
    Inherited from Data
Data __abs__(self)
Absolute value: x.__abs__() <==> abs(x)
Data __add__(self, y)
Add: x.__add__(y) <==> x+y
Data __and__(self, y)
And: x.__and__(y) <==> x&y
Data __div__(self, y)
Divide: x.__div__(y) <==> x/y
Bool __eq__(self, y)
Equals: x.__eq__(y) <==> x==y
Data __float__(self)
Float: x.__float__() <==> float(x)
Data __floordiv__(self, y)
Floordiv: x.__floordiv__(y) <==> x//y
Bool __ge__(self, y)
Greater or equal: x.__ge__(y) <==> x>=y
Data __getitem__(self, y)
Subscript: x.__getitem__(y) <==> x[y]
Bool __gt__(self, y)
Greater than: x.__gt__(y) <==> x>y
int __int__(self)
Integer: x.__int__() <==> int(x)
Data __invert__(self)
Binary not: x.__invert__() <==> ~x
Bool __le__(self, y)
Less than or equal: x.__le__(y) <==> x<=y
Data __len__(self)
Length: x.__len__() <==> len(x)
long __long__(self)
Convert this object to python long
Data __lshift__(self, y)
Lrft binary shift: x.__lshift__(y) <==> x<<y
Bool __lt__(self, y)
Less than: x.__lt__(y) <==> x<y
Data __mod__(self, y)
Modulus: x.__mod__(y) <==> x%y
Data __mul__(self, y)
Multiply: x.__mul__(y) <==> x*y
Data __ne__(self, y)
Not equal: x.__ne__(y) <==> x!=y
Data __neg__(self)
Negation: x.__neg__() <==> -x
Bool __nonzero__(self)
Not equal 0: x.__nonzero__() <==> x != 0
Data __or__(self, y)
Or: x.__or__(y) <==> x|y
Data __pos__(self)
Unary plus: x.__pos__() <==> +x
Data __radd__(self, y)
Reverse add: x.__radd__(y) <==> y+x
Data __rdiv__(self, y)
Reverse divide: x.__rdiv__(y) <==> y/x
string __repr__(self)
Return string representation
Data __rfloordiv__(self, y)
x.__rfloordiv__(y) <==> y//x
Data __rlshift__(self, y)
Reverse left binary shift: x.__rlshift__(y) <==> y<<x
Data __rmod__(self, y)
Reverse modulus: x.__rmod__(y) <==> y%x
Data __rmul__(self, y)
Multiply: x.__mul__(y) <==> x*y
Data __ror__(self, y)
Or: x.__or__(y) <==> x|y
Data __rrshift__(self, y)
Reverse right binary shift: x.__rrshift__(y) <==> y>>x
Data __rshift__(self, y)
Right binary shift: x.__rshift__(y) <==> x>>y
Data __rsub__(self, y)
Reverse subtract: x.__rsub__(y) <==> y-x
Data __rxor__(self, y)
Reverse xor: x.__rxor__(y) <==> y^x
Data __sub__(self, y)
Subtract: x.__sub__(y) <==> x-y
Data __xor__(self, y)
Xor: x.__xor__(y) <==> x^y
Bool bool(self)
Return boolean
Data compile(expr, *args)
Static method (routine in C++) which compiles the expression (via TdiCompile()) and returns the object instance correspondind to the compiled expression. (Static method)
Scalar,Array data(self)
Return primitimive value of the data.
string decompile(self)
Return string representation
Data deserialize(data)
Return Data from serialized buffer. (Static method)
Data dim_of(self, idx)
Return dimension of object
Data evaluate(self)
Return the result of TDI evaluate(this).
Data execute(expr, *args)
Execute and expression inserting optional arguments into the expression before evaluating (Static method)
Int8 getByte(self)
Convert this data into a byte.
Int8Array getByteArray(self)
Convert this data into a byte array.
Data getDimensionAt(self, idx)
Return dimension of object
Float64 getDouble(self)
Convert this data into a float64.
Data getError(self)
Get the error field.
Float32 getFloat(self)
Convert this data into a float32.
Data getHelp(self)
Returns the result of TDI GET_HELP(this).
Int32 getInt(self)
Convert this data into a int.
Int32Array getIntArray(self)
Convert this data into a int array.
Int64 getLong(self)
Convert this data into a long.
Int64Array getLongArray(self)
Convert this data into a long array.
Int32Array getShape(self)
Get the array dimensions as an integer array.
Int16 getShort(self)
Convert this data into a short.
Int16Array getShortArray(self)
Convert this data into a short array.
String getString(self)
Convert this data into a STRING.
Data getTdiVar(tdivarname)
Get value of tdi public variable (Static method)
Data getUnits(self)
Return the TDI evaluation of UNITS_OF(this).
Data makeData(value)
Return MDSplus data class from value. (Static method)
Bool mayHaveChanged(self)
return true if the represented data could have been changed since the last time this method has been called.
Data pop_dollar_value(self)
Pop $value for expression evaluation
None push_dollar_value(self)
Set $value for expression evaluation
Data raw_of(self)
Return raw part of object
Uint8Array serialize(self)
Return Uint8Array binary representation.
None setError(self, error)
Set the Error field for this Data instance.
None setHelp(self, help)
Set the Help field for this Data instance.
Data setTdiVar(self, tdivarname)
Set tdi public variable with this data
None setUnits(self, units)
Set units
Float32Array sind(self)
Return sin() of data assuming data is in degrees
Data units_of(self)
Return units part of the object
Data value_of(self)
Return value part of object
    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

Property Summary
    Inherited from Data
  descriptor
  error
  help
  units
  validation

Instance Variable Summary
    Inherited from TreeNode
int nid: node index of this node.
Tree tree: Tree instance that this node belongs to.

Instance Method Details

beginSegment(self, start, end, dimension, initialValueArray, idx=-1)

Begin a record segment
Parameters:
start - Index of first row of data
           (type=Data)
end - Index of last row of data
           (type=Data)
dimension - Dimension information of segment
           (type=Dimension)
initialValueArray - Initial data array. Defines shape of segment
           (type=Array)
Returns:
None
Overrides:
MDSplus.treenode.TreeNode.beginSegment (inherited documentation)

getCachePolicy(self)

return cache policy for this node

getData(self)

Return data
Overrides:
MDSplus.treenode.TreeNode.getData

getNumSegments(self)

Get number of segments
Overrides:
MDSplus.treenode.TreeNode.getNumSegments

getSegmentEnd(self, idx)

return end of segment
Overrides:
MDSplus.treenode.TreeNode.getSegmentEnd

getSegmentStart(self, idx)

return start of segment
Overrides:
MDSplus.treenode.TreeNode.getSegmentStart

putRow(self, bufsize, array, timestamp)

Load a timestamped segment row
Parameters:
bufsize - number of rows in segment
           (type=int)
array - data for this row
           (type=Array or Scalar)
timestamp - Timestamp of this row
           (type=Uint64)
Returns:
None
Overrides:
MDSplus.treenode.TreeNode.putRow (inherited documentation)

putSegment(self, data, idx)

Load a segment in a node
Parameters:
data - data to load into segment
           (type=Array or Scalar)
idx - index into segment to load data
           (type=int)
Returns:
None
Overrides:
MDSplus.treenode.TreeNode.putSegment (inherited documentation)

putTimestampedSegment(self, array, timestampArray)

Put timestamped segment
Overrides:
MDSplus.treenode.TreeNode.putTimestampedSegment

setCachePolicy(self, policy)

set cache policy for this node

updateSegment(self, start, end, dim, idx)

Update a segment
Overrides:
MDSplus.treenode.TreeNode.updateSegment

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