SequenceTree Class Reference

Tree representation of the sequence. More...

#include <SequenceTree.h>

Collaboration diagram for SequenceTree:

Public Member Functions
	SequenceTree ()
	~SequenceTree ()
void	Initialize (string seqFile)
DOMNodeList *	GetChildNodes (DOMNode *node)
DOMNode *	GetParentNode (DOMNode *node)
DOMNamedNodeMap *	GetAttributes (DOMNode *node)
Module *	GetModule (DOMNode *node)
unsigned int	AddModule (string name)
int	RunTree (DOMNode *node, void *ptr, unsigned int(*fun)(void *, DOMNode *), int depth=0)
unsigned int	Populate (bool verbose=true)
Module *	GetParent (DOMNode *node)
vector< Module * >	GetChildren (DOMNode *node)
vector< Module * >	GetChildrenDynamic (DOMNode *node)
Module *	GetChild (DOMNode *node, unsigned int position)
ConcatSequence *	GetRootConcatSequence ()
ContainerSequence *	GetContainerSequence ()
Module *	GetModuleByAttributeValue (string name, string value)
DOMDocument *	GetDOMDocument ()
ModulePrototypeFactory *	GetMPF ()
map< DOMNode *, Module * > *	GetModuleMap ()
int	GetDepth ()
string	GetSequenceDirectory ()
string	GetSequenceFilename ()
void	SerializeModules (string xml_file)
Parameters *	GetParameters ()
bool	GetStatus ()
	Get my status of parsing XML.

Static Public Member Functions
static unsigned int	CreateModule (void *ptr, DOMNode *node)
static vector< string >	Tokenize (const string &str, const string &delimiters=",")

Private Attributes
bool	m_state
int	m_depth
Parameters *	m_parameters
ConcatSequence *	m_root_seq
DOMDocument *	m_dom_doc
ModulePrototypeFactory *	m_mpf
XMLIO *	m_xio
map< DOMNode *, Module * >	m_Modules
string	m_seq_file
map< DOMNode *, vector< Module * > >	m_node2children

Friends
class	Container

Detailed Description

Tree representation of the sequence.

Constructor & Destructor Documentation

SequenceTree()

SequenceTree::SequenceTree

(

)

default constructor

~SequenceTree()

SequenceTree::~SequenceTree

(

)

public virtual default destructor

Member Function Documentation

AddModule()

unsigned int SequenceTree::AddModule

(

string

name

)

Get a puls based on its name

Parameters

name	Unique name of the Module to be added

CreateModule()

unsigned int SequenceTree::CreateModule ( void * ptr, DOMNode * node )

static

A static function to create modules. Called by SequenceTree::Populate() as function pointer argument to SequenceTree::RunTree() .

Parameters

ptr	Pointer to the SequenceTree object.
node	More elaborate description here please.

Returns

Error code.

Here is the caller graph for this function:

GetAttributes()

DOMNamedNodeMap * SequenceTree::GetAttributes

(

DOMNode *

node

)

Get the attributes of the given node

Parameters

node	the node for which the attributes are requested

GetChild()

Module * SequenceTree::GetChild	(	DOMNode *	node,
		unsigned int	position )

Get child at position

@param node The node referred to.
@param position The position in the vector of children

Here is the call graph for this function:

Here is the caller graph for this function:

GetChildNodes()

DOMNodeList * SequenceTree::GetChildNodes

(

DOMNode *

node

)

Get the child nodes of the given node

Parameters

node	the node for which the child nodes are requested

Returns

pointer to DOMNodeList including the children of the node for which the children are requested

GetChildren()

vector< Module * > SequenceTree::GetChildren

(

DOMNode *

node

)

Get vector of chilren

@param node The node referred to.

Here is the caller graph for this function:

GetChildrenDynamic()

vector< Module * > SequenceTree::GetChildrenDynamic

(

DOMNode *

node

)

Get vector of chilren Dynamic (old non-cached version for dynamic events such as eddy currents)

@param node The node referred to.

Here is the caller graph for this function:

GetContainerSequence()

ContainerSequence * SequenceTree::GetContainerSequence

(

)

Get the ContainerSequence module.

Returns

The ContainerSequence module.

Here is the caller graph for this function:

GetDepth()

int SequenceTree::GetDepth ( )

inline

Get the depth of the tree

Returns

the depth

GetDOMDocument()

DOMDocument * SequenceTree::GetDOMDocument ( )

inline

Get the DOM document

Returns

the requested DOM document

Here is the caller graph for this function:

GetModule()

Module * SequenceTree::GetModule

(

DOMNode *

node

)

Get a Module based on its DOMNode

Parameters

node	The DOMNode

GetModuleByAttributeValue()

Module * SequenceTree::GetModuleByAttributeValue	(	string	name,
		string	value )

Get first module in the tree, which has a matching attribute (name,value) pair in its DOMNode.

Parameters

name	The name of the attribute.
value	The value of the attribute.

Returns

The module.

Here is the call graph for this function:

Here is the caller graph for this function:

GetModuleMap()

map< DOMNode *, Module * > * SequenceTree::GetModuleMap ( )

inline

Get the map of clonable modules

Returns

Map of DOM nodes and modules

Here is the caller graph for this function:

GetMPF()

ModulePrototypeFactory * SequenceTree::GetMPF ( )

inline

Get the module prototype factory

Returns

the requested prototype factory

Here is the caller graph for this function:

GetParameters()

Parameters * SequenceTree::GetParameters ( )

inline

Get pointer to the sole instance of the 'Parameters' module.

Here is the caller graph for this function:

GetParent()

Module * SequenceTree::GetParent

(

DOMNode *

node

)

Get the parent module

Parameters

node	The node referred to.

Here is the caller graph for this function:

GetParentNode()

DOMNode * SequenceTree::GetParentNode

(

DOMNode *

node

)

Get the Parent node of the given node

Parameters

node	the node for which the parent node is requested

Returns

pointer to the requested parent node

GetRootConcatSequence()

ConcatSequence * SequenceTree::GetRootConcatSequence

(

)

Get the root ConcatSequence module.

Returns

The root ConcatSequence module.

Here is the caller graph for this function:

GetSequenceDirectory()

string SequenceTree::GetSequenceDirectory

(

)

Get the directory of the sequence file

Returns

the directory

Here is the caller graph for this function:

GetSequenceFilename()

string SequenceTree::GetSequenceFilename

(

)

Get the filename of the sequence file

Returns

the filename

Here is the caller graph for this function:

Initialize()

void SequenceTree::Initialize

(

string

seqFile

)

Initialize the sole instance

Parameters

seqFile

uri to the xml file representing the sequence tree to to Initialize from

Returns

error code (0: ok, 1: file io error, 2: dtd validation error)

Here is the call graph for this function:

Here is the caller graph for this function:

Populate()

unsigned int SequenceTree::Populate

(

bool

verbose = true

)

Populate sequence

Populate sequence with the given XML by cloning all needed objects.

Here is the call graph for this function:

Here is the caller graph for this function:

RunTree()

int SequenceTree::RunTree	(	DOMNode *	node,
		void *	ptr,
		unsigned int(*)(void *, DOMNode *)	fun,
		int	depth = 0 )

Run through the sequence tree starting with a given node and perform on its children

Parameters

node	The given DOM node
ptr	More elaborate description here please
fun	Pointer to the performing function
depth	Depth of run (default=0).

Returns

The depth of the tree

Here is the call graph for this function:

Here is the caller graph for this function:

SerializeModules()

void SequenceTree::SerializeModules

(

string

xml_file

)

Write xml file containing all modules of the sequence framework.

Here is the call graph for this function:

Tokenize()

static vector< string > SequenceTree::Tokenize ( const string & str, const string & delimiters = "," )

static

A static string tokenizer. Needed for setting module dependencies.

Parameters

str	The string to tokenize.
delimiters	The delimiters to split the string.

Returns

The vector of tokenized sub-strings.

Member Data Documentation

m_depth

int SequenceTree::m_depth

private

The depth of the tree

m_dom_doc

DOMDocument* SequenceTree::m_dom_doc

private

The DOM document containing the whole sequence

m_parameters

Parameters* SequenceTree::m_parameters

private

Pointer to the sole instance of the Parameter Module

m_root_seq

ConcatSequence* SequenceTree::m_root_seq

private

Pointer to the root ConcatSequence

m_seq_file

string SequenceTree::m_seq_file

private

path of sequence file

m_state

bool SequenceTree::m_state

private

My status

---

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

• /Users/stoeckert/DZNE/workspace/jemris/src/SequenceTree.h
• /Users/stoeckert/DZNE/workspace/jemris/src/SequenceTree.cpp