ModuleHierarchyTree

A tree describing the module hierarchy implied in a given Cog model's definition. Supports lookups and traversals.

Basically, any class that has Cog fields as members is called a Module. In addition, any class that has a Module as a member is also called a Module, and is considered a parent to all those member Modules. Any Module that doesn't have a parent is attached as a child to a meta-Module that we just call Root.

The actual reflection/introspection code that finds all these module relationships lives in the field auto-naming logic within ComputeGraph. This class is actually determining the relationships by breaking apart field names.

Example:

class Bar { val scalarField = ScalarField( ... ) }
class Foo { val bar = new Bar() }
val cg = new ComputeGraph {
  val foo = new Foo()
}

In the above compute graph, a single scalar field is created that will be named "foo.bar.scalarField." This name is generated using reflection: the anonymous ComputeGraph has a Foo member named foo which in turn has a Bar member named bar which in turn has a ScalarField member named scalarField. The namer smashes those together to create a long name for the field; this ModuleHierarchyTree class breaks the name back apart to determine relationships between fields and parent objects (the so-called Modules).

Linear Supertypes

AnyRef, Any

Instance Constructors

new ModuleHierarchyTree(circuit: ProbedCircuit)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def allDescendantsFor(module: ModuleNode): Set[FieldNode]

Returns a set of all ProbedFields below this node in the tree.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def contains(field: ProbedField): Boolean
def contains(name: String): Boolean
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(field: ProbedField): Option[FieldNode]
def get(name: String): Option[FieldNode]

Looks for a FieldNode corresponding to the field with the given long name.
Looks for a FieldNode corresponding to the field with the given long name.
name
Long name of the field to look up (e.g. "path.to.a.field")
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasAncestor(node: ModuleTreeNode, ancestor: ModuleNode): Boolean

Checks if 'node' is a descendant of the module 'ancestor'
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val moduleHierarchyRoot: ModuleNode

The root of the module hierarchy.
The root of the module hierarchy. Usually (always?) corresponds to an instance of cogx.runtime.ComputeGraph.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def postOrderTraverse(node: ModuleTreeNode, op: (ModuleTreeNode) ⇒ Unit): Unit
def postOrderTraverse(op: (ModuleTreeNode) ⇒ Unit): Unit
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package cogdebugger

class ModuleHierarchyTree extends AnyRef

Instance Constructors

new ModuleHierarchyTree(circuit: ProbedCircuit)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def allDescendantsFor(module: ModuleNode): Set[FieldNode]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def contains(field: ProbedField): Boolean

def contains(name: String): Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def get(field: ProbedField): Option[FieldNode]

def get(name: String): Option[FieldNode]

final def getClass(): Class[_]

def hasAncestor(node: ModuleTreeNode, ancestor: ModuleNode): Boolean

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val moduleHierarchyRoot: ModuleNode

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def postOrderTraverse(node: ModuleTreeNode, op: (ModuleTreeNode) ⇒ Unit): Unit

def postOrderTraverse(op: (ModuleTreeNode) ⇒ Unit): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped