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

A node. More...

+ Inheritance diagram for Library.Memory.Nodes.ANode:

Public Member Functions

def __init__
 Constructor.
 
def init
 Initializer.
 
def __del__
 Destructor.
 
def asChildOf
 Construct a new node as a child of another node.
 
def insertBefore
 Insert this node before the specified node. More...
 
def insertAfter
 Insert this node after the specified node. More...
 
def prepend
 Prepend the specified node to this node. More...
 
def append
 Append the specified node to this node. More...
 
def adopt
 Adopt the specified node as a child.
 
def detach
 Remove the specified node and its children from the list.
 
def toString
 Return a string representation of the node.
 
def printTo
 Print a string representation of the node and its children to the specified stream.
 
def Previous
 Retrieve the node in the list before the current node. More...
 
def Next
 Retrieve the node in the list after the current node.
 
def Child
 Retrieve the first child of the node.
 
def Parent
 Retrieve the parent of the node.
 
def census
 Calculate the number of children owned by the node.
 
def __getitem__
 Retrieve the specified item from the list of node values.
 
def __setitem__
 Set the specified item in the list of node values.
 
def __contains__
 Determine whether the specified item exists in the list of node values.
 
def update
 Update the values in the list of node values.
 
def __len__
 Determine the "length" of the node – the number of "younger siblings" it contains. More...
 
def __iter__
 Iterates over the node and its younger siblings.
 
- 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...
 

Detailed Description

A node.

Member Function Documentation

def Library.Memory.Nodes.ANode.__len__ (   Self)

Determine the "length" of the node – the number of "younger siblings" it contains.

This routine iterates through the nodes connected to its Next property and counts each node encountered. When used on the first node in a sequence, this value will produce the total number of nodes in the list.

This routine will always return a value of at least 1 because it counts the node on which the method is called.

def Library.Memory.Nodes.ANode.append (   Self,
  ThisNode 
)

Append the specified node to this node.

def Library.Memory.Nodes.ANode.insertAfter (   Self,
  ThisNode 
)

Insert this node after the specified node.

def Library.Memory.Nodes.ANode.insertBefore (   Self,
  ThisNode 
)

Insert this node before the specified node.

def Library.Memory.Nodes.ANode.prepend (   Self,
  ThisNode 
)

Prepend the specified node to this node.

def Library.Memory.Nodes.ANode.Previous (   Self)

Retrieve the node in the list before the current node.


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