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

Type TreeNode

object --+    
         |    
      Data --+
             |
            TreeNode

Known Subclasses:
CachedTreeNode, Device, TreePath

Class to represent an MDSplus node reference (nid).
Method Summary
  __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 beginSegment(self, start, end, dimension, initialValueArray, idx)
Begin a record segment
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
Data getData(self)
Return data
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
int getNumSegments(self)
return number of segments contained in this node
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
Data getSegmentEnd(self, idx)
return end of segment
Data getSegmentStart(self, idx)
return start 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 putData(self, data)
Store data
None putRow(self, bufsize, array, timestamp)
Load a timestamped segment row
None putSegment(self, data, idx)
Load a segment in a node
None putTimestampedSegment(self, timestampArray, array)
Load a timestamped segment
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
None updateSegment(self, start, end, dim, idx)
Update a segment
    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
int nid: node index of this node.
Tree tree: Tree instance that this node belongs to.

Instance Method Details

__init__(self, n, tree=None)
(Constructor)

Initialze TreeNode
Parameters:
n - Index of the node in the tree.
           (type=int)
tree - Tree associated with this node
           (type=Tree)
Overrides:
MDSplus.mdsdata.Data.__init__

__getattr__(self, name)
(Qualification operator)

Implements value=node.attribute

Attributes defined:
  • brother - TreeNode,Next node in tree
  • child - TreeNode,First ancestor
  • children_nids - TreeNodeArray, Children nodes
  • mclass - Uint8, Internal numeric MDSplus descriptor class
  • class_str - String, Name of MDSplus descriptor class
  • compressible - Bool, Flag indicating node contains compressible data
  • compress_on_put - Bool, Flag indicating automatic compression
  • conglomerate_elt - Int32, Index of node in a conglomerate
  • conglomerate_nids - TreeNodeArray, Nodes in same conglomerate
  • data_in_nci - Uint32, Flag indicating data stored in nci record
  • descendants - TreeNodeArray, One level descendants of this node
  • depth - Int32, Level of node from the top node of the tree
  • disabled - Bool, Opposite of on flag
  • do_not_compress - Bool, Flag indicating data should not be compressed
  • dtype - Uint8, Internal numeric MDSplus data type
  • dtype_str - String, Name of MDSplus data type
  • essential - Bool, Flag indicating node is essential, used for actions
  • fullpath - String, Full absolute path of node in tree
  • include_in_pulse - Bool, Flag indicating node should be included in pulse
  • is_child - Bool, Flag indicating node is a child node
  • is_member - Bool, Flag indicating node is a member bnode
  • length - Int32, Length of data in bytes (uncompressed)
  • local_path - str, path to node relative to top of tree containing this node
  • local_tree - str, Name of tree containing this node
  • member - TreeNode, First member of this node
  • member_nids - TreeNodeArray, Members nodes
  • minpath - String, Minimum length string representing path to node
  • nid_number - Int32, Internal index to node in tree
  • nid_reference - Bool, Flag indicating that data contains references to nodes
  • node_name - String, This nodes name
  • no_write_model - Bool, Flag indicating that data cannot be written into model
  • no_write_shot - Bool, Flag indicating that data cannot be written into shot
  • number_of_children - Int32, Number of children of this node
  • number_of_descentants - Int32, Numer of first level descendants
  • number_of elts - Int32, Number of nodes in this conglomerate
  • number_of_members - Int32, Number of members of this node
  • on - Bool, Flag indicating if this node is turned on
  • original_part_name - String, Original node name when conglomerate was created
  • owner_id - Int32, Id/gid of account which stored the data
  • parent - TreeNode, Parent of this node
  • parent_disabled - Bool, Flag indicating parent is turned off
  • path - String, Path to this node
  • path_reference - Bool, Flag indicating that data contains references to nodes
  • record - Data, Contents of this node
  • rfa - Int64, Byte offset to this node
  • rlength - Int32, Data length in bytes (compressed)
  • segmented - Bool, Flag indicating node contains segmented records
  • setup_information - Bool, Flag indicating node contains setup information
  • status - Int32, Completion status of action
  • tags - StringArray, List of tagnames for this node
  • time_inserted - Uint64, Time data was inserted
  • usage - String, Usage of this node
  • versions - Bool, Flag indicating that data contains versions
  • write_once - Bool, Flag indicating that data can only be written if node is empty.
Parameters:
name - Name of attribute
           (type=str)
Returns:
Value of attribute
           (type=various)

__setattr__(self, name, value)

Implements node.attribute=value

Attributes which can be set:
  • compress_on_put - Bool, Flag indicating whether data should be compressed when written
  • do_not_compress - Bool, Flag to disable compression
  • essential - Bool, Flag indicating successful action completion required
  • include_in_pulse - Bool, Flag to include in pulse
  • no_write_model - Bool, Flag to disable writing in model
  • no_write_shot - Bool, Flag to disable writing in pulse file
  • record - Data, Data contents of node
  • subtree - Bool, Set node to be subtree or not (edit mode only)
  • tag - str, Add tag to node (edit mode only)
  • write_once - Bool, Flag to only allow writing to empty node
Parameters:
name - Name of attribute
           (type=str)
value - Value for attribute
           (type=various)
Returns:
None
Overrides:
__builtin__.object.__setattr__

__str__(self)
(Informal representation operator)

Convert TreeNode to string.
Overrides:
MDSplus.mdsdata.Data.decompile

addDevice(self, name, model)

Add device descendant.
Parameters:
name - Node name of device. 1-12 characters, no path delimiters
           (type=str)
model - Type of device to add
           (type=str)
Returns:
Head node of device
           (type=TreeNode)

addNode(self, name, usage='ANY')

Add node
Parameters:
name - Node name of new node to add
           (type=str)
usage - Usage of the new node. If omitted set to ANY.
           (type=str)
Returns:
New now added
           (type=TreeNode)

addTag(self, tag)

Add a tagname to this node
Parameters:
tag - tagname for this node
           (type=str)
Returns:
None

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

beginTimestampedSegment(self, array, idx=-1)

Allocate space for a timestamped segment
Parameters:
array - Initial data array to define shape of segment
           (type=Array)
idx - Optional segment index. Defaults to -1 meaning next segment.
           (type=int)
Returns:
None

compare(self, value)

Returns True if this node contains the same data as specified in the value argument
Parameters:
value - Value to compare contents of the node with
           (type=Data)
Returns:
Bool
Overrides:
MDSplus.mdsdata.Data.compare

containsVersions(self)

Return true if this node contains data versions
Returns:
True if node contains versions
           (type=bool)

delete(self)

Delete this node from the tree
Returns:
None

deleteData(self)

Delete data from this node
Returns:
None

doMethod(self, method, arg=None)

Execute method on conglomerate element
Parameters:
method - method name to perform
           (type=str)
arg - Optional argument for method
           (type=Data)
Returns:
None

getBrother(self)

Return sibling of this node
Returns:
Sibling of this node
           (type=TreeNode)

getChild(self)

Return first child of this node.
Returns:
Return first child of this node or None if it has no children.
           (type=TreeNode)

getChildren(self)

Return TreeNodeArray of children nodes.
Returns:
Children of this node
           (type=TreeNodeArray)

getClass(self)

Return MDSplus class name of this node
Returns:
MDSplus class name of the data stored in this node.
           (type=String)

getCompressedLength(self)

Return compressed data length of this node
Returns:
Compress data length of this node
           (type=int)

getConglomerateElt(self)

Return index of this node in a conglomerate
Returns:
element index of this node in a conglomerate. 0 if not in a conglomerate.
           (type=Int32)

getConglomerateNodes(self)

Return TreeNodeArray of conglomerate elements
Returns:
Nodes in this conglomerate.
           (type=TreeNodeArray)

getData(self)

Return data
Returns:
data stored in this node
           (type=Data)

getDepth(self)

Get depth of this node in the tree
Returns:
number of levels between this node and the top of the currently opened tree.
           (type=Int32)

getDescendants(self)

Return TreeNodeArray of first level descendants (children and members).
Returns:
First level descendants of this node
           (type=TreeNodeArray)

getDtype(self)

Return the name of the data type stored in this node
Returns:
MDSplus data type name of data stored in this node.
           (type=String)

getFullPath(self)

Return full path of this node
Returns:
full path specification of this node.
           (type=String)

getLength(self)

Return uncompressed data length of this node
Returns:
Uncompressed data length of this node
           (type=int)

getLocalPath(self)

Return path relative to top of local tree
Returns:
Path relative to top of local tree
           (type=str)

getLocalTree(self)

Return tree containing this node
Returns:
Name of tree containing this node
           (type=str)

getMember(self)

Return first member node
Returns:
First member of thie node
           (type=TreeNode)

getMembers(self)

Return TreeNodeArray of this nodes members
Returns:
members of this node
           (type=TreeNodeArray)

getMinPath(self)

Return shortest path string for this node
Returns:
shortest path designation depending on the current node default and whether the node has tag names or not.
           (type=String)

getNid(self)

Return node index
Returns:
Internal node index of this node
           (type=int)

getNode(self, path)

Return tree node where path is relative to this node
Parameters:
path - Path relative to this node
           (type=str)
Returns:
node matching path
           (type=TreeNode)

getNodeName(self)

Return node name
Returns:
Node name of this node. 1 to 12 characters
           (type=String)

getNodeWild(self, path)

Return tree nodes where path is relative to this node
Parameters:
path - Path relative to this node
           (type=str)
Returns:
node matching path
           (type=TreeNodeArray)

getNumChildren(self)

Return number of children nodes.
Returns:
Number of children
           (type=Int32)

getNumDescendants(self)

Return number of first level descendants (children and members)
Returns:
total number of first level descendants of this node
           (type=int)

getNumElts(self)

Return number of nodes in this conglomerate
Returns:
Number of nodes in this conglomerate or 0 if not in a conglomerate.
           (type=Int32)

getNumMembers(self)

Return number of members
Returns:
number of members
           (type=int)

getNumSegments(self)

return number of segments contained in this node
Returns:
int

getOriginalPartName(self)

Return the original part name of node in conglomerate
Returns:
Original part name of this node when conglomerate was first instantiated.
           (type=String)

getOwnerId(self)

Get id/gid value of account which wrote data to this node
Returns:
Return user id of last account used to write data to this node
           (type=int)

getParent(self)

Return parent of this node
Returns:
Parent of this node
           (type=TreeNode)

getPath(self)

Return path of this node
Returns:
Path to this node.
           (type=String)

getSegment(self, idx)

Return segment
Parameters:
idx - The index of the segment to return. Indexes start with 0.
           (type=int)
Returns:
Data segment
           (type=Signal | None)

getSegmentDim(self, idx)

Return dimension of segment
Parameters:
idx - The index of the segment to return. Indexes start with 0.
           (type=int)
Returns:
Segment dimension
           (type=Dimension)

getSegmentEnd(self, idx)

return end of segment
Parameters:
idx - segment index to query
           (type=int)
Returns:
Data

getSegmentStart(self, idx)

return start of segment
Parameters:
idx - segment index to query
           (type=int)
Returns:
Data

getStatus(self)

Return action completion status
Returns:
action completion status stored by dispatcher if this node is a dispacted action. Low bit set is success.
           (type=int)

getTags(self)

Return tags of this node
Returns:
Tag names pointing to this node
           (type=ndarray)

getTimeInserted(self)

Return time data was written
Returns:
time data was written to this node as Uint64. Use answer.date to retrieve date/time string
           (type=Uint64)

getTree(self)

Return Tree associated with this node
Returns:
Tree associated with this node
           (type=Tree)

getUsage(self)

Return usage of this node
Returns:
usage of this node
           (type=str)

isChild(self)

Return true if this is a child node
Returns:
True if this is a child node instead of a member node.
           (type=bool)

isCompressible(self)

Return true if node contains data which can be compressed
Returns:
True of this node contains compressible data
           (type=bool)

isCompressOnPut(self)

Return true if node is set to compress on put
Returns:
True if compress on put
           (type=bool)

isDoNotCompress(self)

Return true of compression is disabled for this node
Returns:
True if this node has compression disabled
           (type=bool)

isEssential(self)

Return true if successful action completion is essential
Returns:
True if this node is marked essential.
           (type=bool)

isIncludedInPulse(self)

Return true if this subtree is to be included in pulse file
Returns:
True if subtree is to be included in pulse file creation.
           (type=bool)

isMember(self)

Return true if this is a member node
Returns:
True if this is a member node
           (type=bool)

isNoWriteModel(self)

Return true if data storage to model is disabled for this node
Returns:
Return True if storing data in this node in the model tree is disabled
           (type=bool)

isNoWriteShot(self)

Return true if data storage to pulse file is disabled for this node
Returns:
Return True if storing data in this node in the pulse tree is disabled
           (type=bool)

isOn(self)

Return True if node is turned on, False if not.
Returns:
Return True if node is turned on
           (type=bool)

isSegmented(self)

Return true if this node contains segmented records
Returns:
True if node contains segmented records
           (type=bool)

isSetup(self)

Return true if data is setup information.
Returns:
True if data is setup information (originally written in the model)
           (type=bool)

isWriteOnce(self)

Return true if node is set write once
Returns:
Return True if data overwrite in this node is disabled
           (type=bool)

makeTimestampedSegment(self, timestampArray, array, idx, rows_filled)

Load a timestamped segment
Parameters:
timestampArray - Array of time stamps
           (type=Uint64Array)
array - Data to load into segment
           (type=Array)
idx - int
rows_filled - Number of rows of segment filled with data
           (type=int)
Returns:
None

move(self, parent, newname=None)

Move node to another location in the tree and optionally rename the node
Parameters:
parent - New parent of this node
           (type=TreeNode)
newname - Optional new node name of this node. 1-12 characters, no path delimiters.
           (type=str)
Returns:
None

putData(self, data)

Store data
Parameters:
data - Data to store in this node.
           (type=Data)
Returns:
None

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

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

putTimestampedSegment(self, timestampArray, array)

Load a timestamped segment
Parameters:
timestampArray - Array of time stamps
           (type=Uint64Array)
array - Data to load into segment
           (type=Array)
Returns:
None

removeTag(self, tag)

Remove a tagname from this node
Parameters:
tag - Tagname to remove from this node
           (type=str)
Returns:
None

rename(self, newname)

Rename node this node
Parameters:
newname - new name of this node. 1-12 characters, no path delimiters.
           (type=str)
Returns:
None

restoreContext(self)

Restore tree context. Used by internal functions.
Returns:
None

setCompressOnPut(self, flag)

Set compress on put state of this node
Parameters:
flag - State to set the compress on put characteristic
           (type=bool)
Returns:
None

setDoNotCompress(self, flag)

Set do not compress state of this node
Parameters:
flag - True do disable compression, False to enable compression
           (type=bool)
Returns:
None

setEssential(self, flag)

Set essential state of this node
Parameters:
flag - State to set the essential characteristic. This is used on action nodes when phases are dispacted.
           (type=bool)
Returns:
None

setIncludedInPulse(self, flag)

Set include in pulse state of this node
Parameters:
flag - State to set the include in pulse characteristic. If true and this node is the top node of a subtree the subtree will be included in the pulse.
           (type=bool)
Returns:
None

setNoWriteModel(self, flag)

Set no write model state for this node
Parameters:
flag - State to set the no write in model characteristic. If true then no data can be stored in this node in the model.
           (type=bool)
Returns:
None

setNoWriteShot(self, flag)

Set no write shot state for this node
Parameters:
flag - State to set the no write in shot characteristic. If true then no data can be stored in this node in a shot file.
           (type=bool)
Returns:
None

setOn(self, flag)

Turn node on or off
Parameters:
flag - State to set the on characteristic. If true then the node is turned on. If false the node is turned off.
           (type=bool)
Returns:
None

setSubtree(self, flag)

Enable/Disable node as a subtree
Parameters:
flag - True to make node a subtree reference. Node must be a child node with no descendants.
           (type=bool)
Returns:
None

setTree(self, tree)

Set Tree associated with this node
Parameters:
tree - Tree instance to associated with this node
           (type=Tree)
Returns:
None

setUsage(self, usage)

Set the usage of a node
Parameters:
usage - Usage string.
Returns:
None

setWriteOnce(self, flag)

Set write once state of node
Parameters:
flag - State to set the write once characteristic. If true then data can only be written if the node is empty.
           (type=bool)
Returns:
None

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

Update a segment
Parameters:
start - index of first row of segment
           (type=Data)
end - index of last row of segment
           (type=Data)
dim - Dimension of segment
           (type=Dimension)
idx - Index of segment
           (type=int)
Returns:
None

Instance Variable Details

nid

node index of this node.
Type:
int

tree

Tree instance that this node belongs to.
Type:
Tree

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