DataTree.DummyMerger Class Reference

Detailed Description

a test implementation of an DataTree.ICreator that actually merges two trees together and creates new leaf elements out of the leafs of the two base trees.

Definition at line 18 of file DummyMerger.m.

Inheritance diagram for DataTree.DummyMerger:

Collaboration diagram for DataTree.DummyMerger:

Public Member Functions
	DummyMerger (idsearch)
	constructor of this dummy test example class merging two trees. More...
function DataTree.INode tree =	merge (DataTree.INode left_tree,DataTree.INode right_tree)
	main entry function. This merges a left and a right tree and returns the merged one. More...
function node =	create_leaf_node (arg_node, basepath, mu_cube, tslice)
	merges the leaf nodes More...
Public Member Functions inherited from DataTree.CreatorDefault
function node =	create_tpart_node (t_part_map, initvalues)
	is called on DataTree.PpartNode elements of a DataTree and returns a new p-part node out of it. More...
function node =	create_idmap_node (id_map, initvalues)
	is called on DataTree.IdMapNode elements of a DataTree and returns a new ID mapped node out of it. More...
function node =	create_ppart_node (p_part_map, initvalues)
	is called on DataTree.PpartNode elements of a DataTree and returns a new p-part node out of it. More...
Public Member Functions inherited from DataTree.ICreator
virtual function DataTree.ILeafNode node =	create_leaf_node (DataTree.ILeafNode arg_node, basepath, mu_cube, tslice)
	is called on leaf elements of a DataTree and returns a new leaf out of it. More...

Public Attributes
	idsearch = {"'id1','id2'"}
	restriction to special IDs of the trees. More...
	in_left_tree = true
	transient boolean specifying whether we are in the first (left) tree. More...
DataTree.INode	right_tree = "[]"
	a handle holding the right tree. More...
DataTree.LeafNode	leftnode = "[]"
	last travelled node in the left tree. More...

Constructor & Destructor Documentation

DataTree.DummyMerger.DummyMerger

(

idsearch

)

constructor of this dummy test example class merging two trees.

Paramters

idsearch: a cell array of IDs to restrict the created trees to these IDs.

Parameters

idsearch

idsearch

Definition at line 81 of file DummyMerger.m.

Member Function Documentation

function node = DataTree.DummyMerger.create_leaf_node	(		arg_node,
			basepath,
			mu_cube,
			tslice
	)

merges the leaf nodes

This method expects leafs storing strings and creates new strings with content [left_string, ' + ', right_string] out of it.

Parameters

arg_node	original leaf which shall be used as basis for the creation of a new one.
basepath	path from the root element to the current leaf.
mu_cube	restriction of the parameter as described in Sub-tree definition
tslice	restriction of the time domain as described in Sub-tree definition

Return values

node	the freshly generated leaf element

Definition at line 115 of file DummyMerger.m.

function DataTree.INode tree = DataTree.DummyMerger.merge	(	DataTree.INode	left_tree,
		DataTree.INode	right_tree
	)

main entry function. This merges a left and a right tree and returns the merged one.

Parameters

left_tree	left tree
right_tree	right tree

Return values

tree	merged tree

Definition at line 98 of file DummyMerger.m.

Member Data Documentation

DataTree.DummyMerger.idsearch = {"'id1','id2'"}

restriction to special IDs of the trees.

Default: {"'id1','id2'"}

Definition at line 31 of file DummyMerger.m.

DataTree.DummyMerger.in_left_tree = true

transient boolean specifying whether we are in the first (left) tree.

Note

This property has the MATLAB attribute Transient set to true.

Matlab documentation of property attributes.
Default: true

Definition at line 42 of file DummyMerger.m.

DataTree.DummyMerger.leftnode = "[]"

last travelled node in the left tree.

Note

This property has the MATLAB attribute Transient set to true.

Matlab documentation of property attributes.
Default: "[]"

Definition at line 66 of file DummyMerger.m.

DataTree.DummyMerger.right_tree = "[]"

a handle holding the right tree.

Note

This property has the MATLAB attribute Transient set to true.

Matlab documentation of property attributes.
Default: "[]"

Definition at line 54 of file DummyMerger.m.

---

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

• general/+DataTree/DummyMerger.m