Simulator Class Reference

The simulator. More...

#include <Simulator.h>

Collaboration diagram for Simulator:

List of all members.

Public Member Functions
	Simulator (string fname, string fsample="", string frxarray="", string ftxarray="", string fsequence="", string fmodel="")
	Construct a new simulator with given XML descriptor.
virtual	~Simulator ()
	Default destructor.
bool	GetStatus ()
	Get my status.
int	GetEvolution ()
	Get my evolution counter.
string	GetAttr (DOMElement *element, 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 (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 ()
Protected Member Functions
	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.

---

Detailed Description

The simulator.

Definition at line 40 of file Simulator.h.

---

Constructor & Destructor Documentation

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

Construct a new simulator with given XML descriptor.

Parameters:

fname

XML cofguration file

Definition at line 42 of file Simulator.cpp.

References XMLIO::Parse(), Sample::ReorderSample(), SetModel(), SetParameter(), SetRxCoilArray(), SetSample(), SetSequence(), SetTxCoilArray(), and SetWorld().

Here is the call graph for this function:

---

Member Function Documentation

void Simulator::DeleteTmpFiles

(

)

delete restart files (after successful simulation)

Definition at line 299 of file Simulator.cpp.

References CoilArray::GetSize().

Referenced by Simulate().

Here is the call graph for this function:

Here is the caller graph for this function:

string Simulator::GetAttr	(	DOMElement *	element,
		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

Definition at line 243 of file Simulator.cpp.

Referenced by SetModel(), SetParameter(), SetRxCoilArray(), SetSample(), SetSequence(), and SetTxCoilArray().

Here is the caller graph for this function:

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

DOMElement * Simulator::GetElem

(

string

name

)

Get a particular element from my DOM document.

Parameters:

name

The name of the element

Definition at line 248 of file Simulator.cpp.

Referenced by SetModel(), SetParameter(), SetRxCoilArray(), SetSample(), SetSequence(), and SetTxCoilArray().

Here is the caller graph for this function:

Model* Simulator::GetModel

(

)

[inline]

Get the model.

Returns:

The model.

Definition at line 126 of file Simulator.h.

CoilArray* Simulator::GetRxCoilArray

(

)

[inline]

Get the transmitting coil array.

Returns:

Definition at line 147 of file Simulator.h.

Sample* Simulator::GetSample

(

)

[inline]

Get the sample.

Returns:

The sample

Definition at line 119 of file Simulator.h.

ConcatSequence* Simulator::GetSequence

(

)

[inline]

Get the sequence.

Returns:

The sequence

Definition at line 133 of file Simulator.h.

CoilArray* Simulator::GetTxCoilArray

(

)

[inline]

Get the recieving coil array.

Returns:

The recieving coil array

Definition at line 140 of file Simulator.h.

---

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

• Simulator.h
• Simulator.cpp