Example Class Reference

#include <Example.h>

Inheritance diagram for Example:

List of all members.

Public Member Functions
	Example ()
virtual	~Example ()
virtual void	setup (string)
virtual int	getVersion () const
virtual string	getSpecs ()
virtual string	getLogic ()
virtual bool	nSpecs ()
virtual bool	nLogic ()
virtual string	retrieveNodeLevel ()
virtual void	sendNodeLevel (string, int)
virtual pair< string, int >	setInputNodeLevel ()
virtual void	initialize ()
virtual void	preSim ()
virtual void	midSim ()
virtual void	postSim ()
virtual void	close ()
Private Attributes
vector< string >	args
int	x
int	y

---

Constructor & Destructor Documentation

Example::Example

(

)

[inline]

virtual Example::~Example

(

)

[inline, virtual]

---

Member Function Documentation

void Example::close

(

void

)

[virtual]

This function will be called after every simulation has been completed. Please close any filestreams that need to be close and free any errant memory.

Implements Plugin.

string Example::getLogic

(

void

)

[virtual]

This function returns the location of the logic file you would like the simulation to use.

Implements Plugin.

string Example::getSpecs

(

void

)

[virtual]

This function returns the location of the specs file you would like the simulation to use.

Implements Plugin.

int Example::getVersion

(

)

const [virtual]

Implements Plugin.

void Example::initialize

(

void

)

[virtual]

This function is called at the beggining of the program

Implements Plugin.

void Example::midSim

(

)

[virtual]

This function is called every step during a simulation, perform any ongoing analysis here

Implements Plugin.

bool Example::nLogic

(

)

[virtual]

This function will return true if you have a new logic file to supply to the Simulation, if you return true the function getLogic() will be called directly after this one.

Implements Plugin.

bool Example::nSpecs

(

)

[virtual]

This function will return true if you have a new specs file to supply to the Simulation, if you return true the function getSpecs() will be called directly after this one.

Implements Plugin.

void Example::postSim

(

void

)

[virtual]

This function will be called after every simulation, after the output file have been written. perform any post-simulation analysis here.

Implements Plugin.

void Example::preSim

(

void

)

[virtual]

This function is called before every Simulation, perform any pre-simulation analysis here.

Implements Plugin.

string Example::retrieveNodeLevel

(

)

[virtual]

Every iteration, after t is set appriopriately this function will be called repeatedly untill you return a blank string. When you return something other than a blank string simulation will determine the current level of that boolean node, if one exists and call sendNodeLevel(string, int) with the node's name and level

Implements Plugin.

void Example::sendNodeLevel	(	string	,
		int
	)			[virtual]

This function is called to provide the Plugin with boolean node levels that it has requested.

Implements Plugin.

pair< string, int > Example::setInputNodeLevel

(

)

[virtual]

After the function midSim() is called, this function will be called repeatedly untill untill the returned pair has a blank string in it. When this function returns a pair without a blank string in it the Simulation will set teh corresponding Input Node, if any exists, to the level of the integer in the pair.

Implements Plugin.

void Example::setup

(

string

path

)

[virtual]

This function takes the inputfile and reads all lines that do not begin with '#' and puts them into the string vector args.

Implements Plugin.

---

Member Data Documentation

vector<string> Example::args [private]

int Example::x [private]

int Example::y [private]

---

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

• Plugins/Example/Example.h
• Plugins/Example/Example.cpp