#include <Prototype.h>

Inheritance diagram for Prototype:

Collaboration diagram for Prototype:

Public Member Functions
	Prototype ()
	Constructor.

virtual	~Prototype ()
	Default destructor.

	Prototype (const Prototype &)
	Default copy constructor.

virtual Prototype *	GetParent ()
	Get Parent.

virtual Prototype *	Clone () const =0
	Clone a prototype.

virtual bool	Prepare (PrepareMode mode)=0
	Prepare this pulse.

bool	IsPrepared ()
	Check if the Prototype is prepared.

virtual void	Initialize (DOMNode *conf)=0
	Initialise this prototype.

void	SetName (string name)
	Set the name of this module.

DOMNode *	GetNode ()
	Get the DOMNode of this module.

void	SetNode (DOMNode *node)
	Set the DOMNode of this module.

string	GetClassType ()
	Get the class type of this prototype.

Type	GetType ()
	Get the module type of this module.

string	GetDOMattribute (const string attribute)
	Get attribute value from the DOMNode.

bool	HasDOMattribute (const string attribute)
	Check, if attribute exists in DOM node of this module.

Attribute *	GetAttribute (string name)
	Get an Attribute.

void	CopyObservers (Attribute a1, Attribute a2)
	Copy observers from one attribute to another.

bool	HasAttribute (string name)
	Check if an attribute exist.

void	HideAttribute (string attrib, bool observable=true)
	Hide an attribute.

virtual Prototype *	GetPrototypeByAttributeValue (string name, string attrib)
	Get a Prototype by value of an attribute.

string	GetName ()
	Get the name of this module.

bool	Observe (Attribute *attrib, string prot_name, string attrib_name, bool verbose)
	Set up the list of observations.

bool	Observe (Attribute *attrib, string prot_name, string attrib_name, string attrib_keyword, bool verbose)

template<typename T >
bool	Notify (const T &val)
	Notify all observers of an attribute.

template<typename T >
bool	NewState (const T &val)
	Check the state of an attribute.

vector< double > *	GetVector ()
	Each Prototype has a double vector as a private member, which values can be filled through XML and accessed from attributes within the same Prototype.

Static Public Member Functions
static bool	ReplaceString (string &str, const string &s1, const string &s2)
	A global sub-string replacer.

static bool	ReplaceSymbolString (string &str, const string &s1, const string &s2)
	A global sub-string replacer which replaces only complete symbol strings.

static vector< string >	Tokenize (const string &str, const string &delimiters=",")
	A global string tokenizer.

Protected Attributes
bool	m_aux
	auxiliary helper variable for debugging purposes

bool	m_prepared
	True, after the first call to Prepare.

string	m_name
	Name of this Prototype.

DOMNode *	m_node
	The node configuring this Module.

Type	m_type
	The type of the module: one of MOD_PULSE, MOD_ATOM, MOD_CONCAT.

vector< double >	m_vector
	A vector which elements are accessible through loop counters.

map< string, Attribute * >	m_attributes
	Map to connect a keyword with an Attribute.

vector< Attribute * >	m_obs_attribs
	Vector of observed Attributes.

vector< string >	m_obs_attrib_keyword
	Vector of user-defined Attribute names.

Detailed Description

Prototype super class.

Constructor & Destructor Documentation

◆ Prototype() [1/2]

Prototype::Prototype ( )

inline

Constructor.

Default constructor

◆ ~Prototype()

virtual Prototype::~Prototype ( )

inlinevirtual

Default destructor.

Delete my attributes

◆ Prototype() [2/2]

Prototype::Prototype ( const Prototype & )

inline

Default copy constructor.

Member Function Documentation

◆ Clone()

virtual Prototype * Prototype::Clone ( ) const

pure virtual

Clone a prototype.

Create and recieve a Clone of an unprepared prototype.

Implemented in AnalyticCoil, AnalyticGradPulse, AnalyticRFPulse, AtomicSequence, BiotSavartLoop, ConcatSequence, ConstantGradPulse, Container, ContainerSequence, DelayAtomicSequence, EddyPulse, EmptyPulse, ExternalCoil, ExternalGradPulse, ExternalRFPulse, GaussianRFPulse, HardRFPulse, IdealCoil, Parameters, SechRFPulse, SincRFPulse, SpiralGradPulse, TrapGradPulse, TriangleGradPulse, Coil, and Module.

Here is the caller graph for this function:

◆ CopyObservers()

void Prototype::CopyObservers	(	Attribute *	a1,
		Attribute *	a2 )

Copy observers from one attribute to another.

Parameters

a1	source attribute (copy from here)
a1	target attribute (copy to here)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAttribute()

Attribute * Prototype::GetAttribute ( string name )

Get an Attribute.

Parameters

name	The name of the attribute.

Returns: The Attribute.

Here is the caller graph for this function:

◆ GetClassType()

string Prototype::GetClassType ( )

inline

Get the class type of this prototype.

Returns: The tag name of the DOMNode.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDOMattribute()

string Prototype::GetDOMattribute ( const string attribute )

inline

Get attribute value from the DOMNode.

Parameters

attribute The attribute of the DOMNode corresponding to this Module.

Returns: The value of the attribute

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetName()

string Prototype::GetName ( )

inline

Get the name of this module.

Returns: The value of the private member m_name

Here is the caller graph for this function:

◆ GetNode()

DOMNode * Prototype::GetNode ( )

inline

Get the DOMNode of this module.

Returns: The value of the private member m_node

Here is the caller graph for this function:

◆ GetParent()

virtual Prototype * Prototype::GetParent ( )

inlinevirtual

Get Parent.

Returns: Parent module.

Reimplemented in Module.

Here is the caller graph for this function:

◆ GetPrototypeByAttributeValue()

virtual Prototype * Prototype::GetPrototypeByAttributeValue	(	string	name,
		string	attrib )

inlinevirtual

Get a Prototype by value of an attribute.

Parameters

name	Attribute name
attrib	Attribute value

Returns: Found Prototype

Reimplemented in Module.

◆ GetType()

Type Prototype::GetType ( )

inline

Get the module type of this module.

Returns: The module type: one of MOD_PULSE, MOD_ATOM, MOD_CONCAT

Here is the caller graph for this function:

◆ GetVector()

vector< double > * Prototype::GetVector ( )

inline

Each Prototype has a double vector as a private member, which values can be filled through XML and accessed from attributes within the same Prototype.

Returns: Pointer to the double vector of this Prototype

Here is the caller graph for this function:

◆ HasAttribute()

bool Prototype::HasAttribute ( string name )

inline

Check if an attribute exist.

Parameters

name	The name of the attribute

Returns: Success/Failure of operation.

Here is the call graph for this function:

◆ HasDOMattribute()

bool Prototype::HasDOMattribute ( const string attribute )

inline

Check, if attribute exists in DOM node of this module.

Parameters

attribute The attribute of the DOMNode corresponding to this Module.

Returns: True, if attribute exists in DOM (XML)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HideAttribute()

void Prototype::HideAttribute	(	string	attrib,
		bool	observable = true )

Hide an attribute.

Attributes, which were declared with the ATTRIBUTE command in a base class will be declared as invisible, i.e. they can not be set through XML. This method has to called in the particular Prepare function of a method, however, after the base class Prepare call.

Parameters

attrib	Name of the attribute to hide
observable	Keep this attribute still observable? (default: true)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialize()

virtual void Prototype::Initialize ( DOMNode * conf )

pure virtual

Initialise this prototype.

Parameters

conf	DOMNode with configuration

Implemented in Coil, and Module.

◆ IsPrepared()

bool Prototype::IsPrepared ( )

inline

Check if the Prototype is prepared.

Returns: True, if prepared.

Here is the caller graph for this function:

◆ NewState()

template<typename T >

bool Prototype::NewState ( const T & val )

inline

Check the state of an attribute.

Parameters

private member variable.

Returns: true, if member has changed

Here is the caller graph for this function:

◆ Notify()

template<typename T >

bool Prototype::Notify ( const T & val )

inline

Notify all observers of an attribute.

Parameters

val	member variable.

Returns: true, if member has changed

Here is the caller graph for this function:

◆ Observe()

bool Prototype::Observe	(	Attribute *	attrib,
		string	prot_name,
		string	attrib_name,
		bool	verbose )

Set up the list of observations.

This function creates an Attribute list for all observations from this Prototype. It further attaches the current attribute to the observer list of the observed attributes.

Parameters

attrib	The observer (An Attribute of this Prototype)
prot_name	Name of the Prototype which holds the Attribute to observe
attrib_name	Name of the Attribute to observe
verbose	If true, dump possible warnings to stdout

Returns: success/failure of operation

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Prepare()

bool Prototype::Prepare ( PrepareMode mode )

pure virtual

Prepare this pulse.

Called many times when root node prepares. First time not verbose. Successors must overload this method.

Parameters

mode	Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.

Returns: Success

Implemented in AnalyticCoil, AnalyticGradPulse, AtomicSequence, BiotSavartLoop, Coil, ConcatSequence, ConstantGradPulse, Container, ContainerSequence, DelayAtomicSequence, ExternalCoil, ExternalGradPulse, ExternalRFPulse, HardRFPulse, Module, Pulse, RFPulse, Sequence, SpiralGradPulse, TriangleGradPulse, Parameters, AnalyticRFPulse, EddyPulse, EmptyPulse, GaussianRFPulse, GradPulse, SechRFPulse, SincRFPulse, and TrapGradPulse.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReplaceString()

bool Prototype::ReplaceString	(	string &	str,
		const string &	s1,
		const string &	s2 )

static

A global sub-string replacer.

Parameters

str	The string to change.
s1	The sub-string to be replaced.
s2	The sub-string to be inserted instead.

Returns: True, if replacing took place at least once (s1 was in str).

Here is the caller graph for this function:

◆ SetName()

void Prototype::SetName ( string name )

Set the name of this module.

Parameters

name	New name of this module

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetNode()

void Prototype::SetNode ( DOMNode * node )

inline

Set the DOMNode of this module.

Parameters

node	The new DOMNode

Here is the caller graph for this function:

◆ Tokenize()

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

static

A global string tokenizer.

Parameters

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

Returns: The vector of tokenized sub-strings.

Here is the caller graph for this function:

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

/Users/stoeckert/DZNE/workspace/jemris/src/Prototype.h
/Users/stoeckert/DZNE/workspace/jemris/src/Prototype.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Prototype() [1/2]

◆ ~Prototype()

◆ Prototype() [2/2]

Member Function Documentation

◆ Clone()

◆ CopyObservers()

◆ GetAttribute()

◆ GetClassType()

◆ GetDOMattribute()

◆ GetName()

◆ GetNode()

◆ GetParent()

◆ GetPrototypeByAttributeValue()

◆ GetType()

◆ GetVector()

◆ HasAttribute()

◆ HasDOMattribute()

◆ HideAttribute()

◆ Initialize()

◆ IsPrepared()

◆ NewState()

◆ Notify()

◆ Observe()

◆ Prepare()

◆ ReplaceString()

◆ SetName()

◆ SetNode()

◆ Tokenize()