Detailed Description

Simple DataTree.ICreator copying the original tree and applying a custom function to its leafs returning a scalar value.

This creator is used by the INode.create_scalar_tree() method.

Definition at line 18 of file ScalarCreator.m.

Inheritance diagram for DataTree.ScalarCreator:

Collaboration diagram for DataTree.ScalarCreator:

Public Member Functions
	ScalarCreator (funcptr)
	constructor of this creator More...

function node =	create_leaf_node (arg_node, basepath, mu_cube, tslice)
	is called on leaf elements of a DataTree and returns a new leaf out of it. 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
	funcptr
	function_handle to a custom function applied to all leaf elements More...

Constructor & Destructor Documentation

DataTree.ScalarCreator.ScalarCreator ( funcptr )

constructor of this creator

Parameters

funcptr function handle to a custom function applied to all leaf elements

Definition at line 47 of file ScalarCreator.m.

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

is called on leaf elements of a DataTree and returns a new leaf 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 58 of file ScalarCreator.m.

DataTree.ScalarCreator.funcptr

function_handle to a custom function applied to all leaf elements

The function synopsis is: ret = funcptr(arg_node)

Definition at line 35 of file ScalarCreator.m.

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