Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Library.Memory.BinaryTrees.ABinaryLeaf Class Reference

A node in a binary tree. More...

+ Inheritance diagram for Library.Memory.BinaryTrees.ABinaryLeaf:

Public Member Functions

def __init__
 Constructor.
 
def init
 Initializer.
 
def writeTo
 Writes the node and its associated subtrees to the stream. More...
 
def readFrom
 Read an individual node from the specified stream. More...
 
def toString
 Construct a string representation of the node. More...
 
def key
 Retrieve the key used to sort the node. More...
 
- Public Member Functions inherited from Library.Base.Classwork.AnObject
def init
 Initialize a new object instance. More...
 
def __init__
 Construct and initialize a new instance of AnObject. More...
 
def __del__
 Destroy the object instance. More...
 
def displayName
 Construct a "pretty" display name for the class instance, based on the name of its class. More...
 
def implements
 Determine whether the class instance is related to the specified class. More...
 
def toString
 Return a string representation of the class, suitable for output to a console or text-based device. More...
 
def __str__
 Return a string representation of the class. More...
 
def classname
 Return the name of the class from which the instance was created. More...
 
def name
 Return the name of the class. More...
 
- Public Member Functions inherited from Library.String.Utilities.IsPrintable
def toString
 Return a string representation of the class conveniently. More...
 
def __str__
 Return a string representation of the class. More...
 
def printTo
 Print a string representation of the class to the specified stream. More...
 
- Public Member Functions inherited from Library.IO.Streams.IsStreamable
def writeTo
 Write class instance data to the specified stream. More...
 
def readFrom
 Read class instance data from the specified stream. More...
 

Detailed Description

A node in a binary tree.

While this class may seem redundant where Python dictionary objects are available, it allows us to standardize the way items are stored in that dictionary, which is useful for something like a language parser.

Member Function Documentation

def Library.Memory.BinaryTrees.ABinaryLeaf.key (   Self)

Retrieve the key used to sort the node.

def Library.Memory.BinaryTrees.ABinaryLeaf.readFrom (   Self,
  Source 
)

Read an individual node from the specified stream.

This method is designed to do the reverse of what the streamTo() method does. It reads an individaul node from the specified stream and returns the total number of bytes read.

def Library.Memory.BinaryTrees.ABinaryLeaf.toString (   Self)

Construct a string representation of the node.

The representation uses the format specified by #blStringRepresentation.

def Library.Memory.BinaryTrees.ABinaryLeaf.writeTo (   Self,
  Dest 
)

Writes the node and its associated subtrees to the stream.

The total number of bytes written to the stream is returned.


The documentation for this class was generated from the following file: