rbmatlab  1.16.09
 All Classes Namespaces Files Functions Variables Modules Pages
List of all members | Public Member Functions | Public Attributes
DataTree.DummyLeafNode Class Reference

Detailed Description

Dummy implementation for a DataTree.ILeafNode that stores a single data.

This class is used for tests and as a leaf for the DataTree.IdMapNode

Definition at line 18 of file DummyLeafNode.m.

Inheritance diagram for DataTree.DummyLeafNode:
Inheritance graph
[legend]
Collaboration diagram for DataTree.DummyLeafNode:
Collaboration graph
[legend]

Public Member Functions

 DummyLeafNode (value)
 constructor More...
 
function index = get_index (dummy, dummy2, dummy3)
 Obtains the leaf index vector that best fits the child description given by the three arguments. More...
 
function valueget (index)
 Access to a child of the current node. More...
 
function this = set_values (value)
 sets the value of the LeafNode More...
 
- Public Member Functions inherited from DataTree.ILeafNode
function
children = 
length ()
 Returns the number of children of the node. More...
 
function index = get_index (dummy2, dummy3, dummy)
 Obtains the leaf index vector that best fits the child description given by the three arguments. More...
 
function this = set (dummy2,DataTree.INode value)
 Sets a child at the given path in the tree hierarchy. More...
 
function data = get (index)
 Access to a child of the current node. More...
 
function DataTree.ILeafNode node = get_active_leaf (DataTree.IModel model, id)
 retuns the leaf element for the current IDetailedModel configuration. More...
 
function tree = create_tree (creator, ids, mu_cube, tslice, basepath)
 Creates a new tree from a subtree specified by ids, parameter and time index regions. More...
 
- Public Member Functions inherited from DataTree.INode
virtual function DataTree.INode tree = create_tree (DataTree.ICreator creator, ids, mu_cube, tslice, basepath)
 Creates a new tree from a subtree specified by ids, parameter and time index regions. More...
 
virtual function this = set (index, value)
 Sets a child at the given path in the tree hierarchy. More...
 
function  leaf_func (funcptr, ids, mu_cube, tslice)
 applies a function to all leafs of a DataTree More...
 
function tree = create_scalar_tree (funcptr, ids, mu_cube, tslice)
 copies the current trees with different leafs. These leafs are computes by a function returning scalar values. More...
 
function
start_index = 
traverse_start ()
 Start iterator for a full traverse of the DataTree. More...
 
function
next_index = 
traverse_next (this_index)
 iterator for a full traverse of the DataTree. More...
 
function
description = 
get_active_leaf_description (IModel model, ids)
 returns an enumeration of all leaves' basepath index vectors with a description of their parents. More...
 
function
description = 
get_leaf_description (ids, mu_cube, tslice)
 returns an enumeration of all leaves' basepath index vectors with a description of their parents. More...
 
function tstop = index_valid_till (index)
 Returns the last valid time step index of a time slice. More...
 
function INode data = get_by_description (id, mu, nt)
 A combination of get_index() and get() More...
 
function
active_leaf_index = 
get_active_leaf_index (IModel model, id)
 retuns the leaf element index for the current IDetailedModel configuration. More...
 
function DataTree.LeafNode
active_leaf = 
get_active_leaf (IModel model, id)
 retuns the leaf element for the current IDetailedModel configuration. More...
 
function  display (fn, basepath, name)
 overwrites the standard display method for DataTree objects More...
 
function lines = disp_node (basepath, fn)
 returns a cell array of strings with information on the node. More...
 

Public Attributes

 value
 data stored in leaf node
 

Constructor & Destructor Documentation

DataTree.DummyLeafNode.DummyLeafNode (   value)

constructor

Parameters
valuedata stored in leaf node

Definition at line 43 of file DummyLeafNode.m.

Member Function Documentation

function value = DataTree.DummyLeafNode.get (   index)
virtual

Access to a child of the current node.

Parameters
indexneeds to be equal to 1.
Return values
valuethe data stored with this leaf element

Implements DataTree.INode.

Definition at line 69 of file DummyLeafNode.m.

function index = DataTree.DummyLeafNode.get_index (   dummy,
  dummy2,
  dummy3 
)
virtual

Obtains the leaf index vector that best fits the child description given by the three arguments.

Parameters
dummydummy
dummy2dummy2
dummy3dummy3
Return values
index=[]

Implements DataTree.INode.

Definition at line 54 of file DummyLeafNode.m.

function this = DataTree.DummyLeafNode.set_values (   value)

sets the value of the LeafNode

Parameters
valuevalue
Return values
thisthis
Generated fields of this:
  • value —  value

Definition at line 83 of file DummyLeafNode.m.


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