Simulator Class Reference

The simulator. More...

#include <Simulator.h>

Collaboration diagram for Simulator:

Public Member Functions
	Simulator (const std::string &fname, const std::string &fsample="", const std::string &frxarray="", const std::string &ftxarray="", const std::string &fsequence="", const std::string &fmodel="")
	Construct a new simulator with given XML descriptor.
virtual	~Simulator ()
	Default destructor.
bool	GetStatus () const
	Get my status.
int	GetEvolution () const
	Get my evolution counter.
string	GetAttr (DOMElement *element, const string &key)
	Get a particular attribute value by a given key string.
string	GetAtts (DOMElement *element, string *keys)
	Get a array of attributes given by the array of key strings.
DOMElement *	GetElem (string name)
	Get a particular element from my DOM document.
void	Simulate (bool bDumpSignal=true)
	Start the simulation after every necessary credentials have been set.
void	SetSample (std::string fsample)
	Set my sample from XML.
void	SetSample (Sample *sample)
	Set my sample to a new sample.
Sample *	GetSample ()
	Get the sample.
Model *	GetModel ()
	Get the model.
ConcatSequence *	GetSequence ()
	Get the sequence.
CoilArray *	GetTxCoilArray ()
	Get the recieving coil array.
CoilArray *	GetRxCoilArray ()
	Get the transmitting coil array.
void	SetSequence (string seq="")
	Set my sequence according to XML configuration.
void	CheckRestart ()
	Checks if restart files present; sets jemris state.
void	DeleteTmpFiles ()
	Simulator ()
	Default constructor.
void	SetWorld ()
	Initialize my world singleton.
void	SetRxCoilArray (string frxarray="")
	Set up my recieve coils according to XML configuration.
void	SetTxCoilArray (string ftxarray="")
	Set up my Transmit coils according to XML configuration.
void	SetModel (string fmodel="")
	Set my solver model according to XML configuration.
void	SetParameter ()
	Set miscellaneous parameters according to XML configuration.
void	SetOutputDir (string output_dir)
	Set output directory.
void	SetSignalPrefix (string prefix)
	Set signal prefix.

Private Member Functions
void	MoveTmpFiles ()

Private Attributes
bool	m_state
	My status
int	m_evol
	Evolution steps
DOMDocument *	m_dom_doc
	Simulation file
Sample *	m_sample
	Sample
World *	m_world
	World to be simulated
Model *	m_model
	Model to be simulated
ConcatSequence *	m_sequence
	Sequence to be simulated
SequenceTree *	m_seqtree
	SequenceTree to be simulated.
XMLIO *	m_xio
	XML file handler
CoilArray *	m_tx_coil_array
	Transmit coil array
CoilArray *	m_rx_coil_array
	Receive coil array
DOMTreeErrorReporter *	m_domtree_error_rep
	DOM tree error reporter
KSpace< double, 4 > *	m_kspace
	K-Space
string	m_output_dir
	Output directory
string	m_signal_prefix
	Signal prefix

Detailed Description

The simulator.

Constructor & Destructor Documentation

Simulator()

Simulator::Simulator	(	const std::string &	fname,
		const std::string &	fsample = "",
		const std::string &	frxarray = "",
		const std::string &	ftxarray = "",
		const std::string &	fsequence = "",
		const std::string &	fmodel = "" )

Construct a new simulator with given XML descriptor.

Parameters

fname	File name of XML configuration
fsample	File name of sample
ftxarray	File name of RX array
frxarray	File name of TX array
fsequence	File name of sequence
fmodel	Model name

Member Function Documentation

DeleteTmpFiles()

void Simulator::DeleteTmpFiles

(

)

delete restart files (after successful simulation)

Here is the call graph for this function:

Here is the caller graph for this function:

GetAttr()

string Simulator::GetAttr	(	DOMElement *	element,
		const string &	key )

Get a particular attribute value by a given key string.

Parameters

element	The element for which the attribute is requested
key	The key of the attribute

Returns

The requested attribute string

Here is the call graph for this function:

Here is the caller graph for this function:

GetAtts()

string Simulator::GetAtts	(	DOMElement *	element,
		string *	keys )

Get a array of attributes given by the array of key strings.

Parameters

element	The element for which the attribute is requested
keys	The array of key strings of the attributes

Returns

The requested array of attribute strings

GetElem()

DOMElement * Simulator::GetElem

(

string

name

)

Get a particular element from my DOM document.

Parameters

name	The name of the element

Here is the caller graph for this function:

GetModel()

Model * Simulator::GetModel ( )

inline

Get the model.

Returns

The model.

GetRxCoilArray()

CoilArray * Simulator::GetRxCoilArray ( )

inline

Get the transmitting coil array.

Returns

GetSample()

Sample * Simulator::GetSample ( )

inline

Get the sample.

Returns

The sample

GetSequence()

ConcatSequence * Simulator::GetSequence ( )

inline

Get the sequence.

Returns

The sequence

GetTxCoilArray()

CoilArray * Simulator::GetTxCoilArray ( )

inline

Get the recieving coil array.

Returns

The recieving coil array

MoveTmpFiles()

void Simulator::MoveTmpFiles ( )

private

moves restart files to *.bak if the do not fit to current simulation

Here is the call graph for this function:

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/Simulator.h
• /Users/stoeckert/DZNE/workspace/jemris/src/Simulator.cpp