ConfigCanvas Class Reference

ConfigCanvas. More...

#include <ConfigCanvas.h>

Inheritance diagram for ConfigCanvas:

List of all members.

Public Member Functions
	ConfigCanvas (string name=DEFAULT_SIMULATION_NAME, int cellSize=DEFAULT_CELL_SIZE, long interval=DEFAULT_INTERVAL)
	Constructor.
	ConfigCanvas (TiXmlElement *node)
	Constructs object using data from XML node.
virtual	~ConfigCanvas ()
	Destructor.
virtual void	ShowEditationWindow (wxWindow *parent, bool waitUntilClosed=true)
	Shows editation window where the user can edit the config.
virtual TiXmlElement *	CreateXmlNode () const
	Creates node representing the config.
int	GetCellSize () const
	Gets starting cell size.
long	GetInterval () const
	Gets period (interval) between two steps.
const string &	GetSimulationName () const
	Gets simulation name.
void	SetSimulationName (string newSimulationName)
	Sets new simulation name.
Private Attributes
int	startingCellSize
	Size of one cell in the starting view, in pixels.
long	startingInterval
	Time period between two steps.
string	simulationName
	Name of the simulation.
Static Private Attributes
static const int	DEFAULT_CELL_SIZE = 32
	Default cell size.
static const long	DEFAULT_INTERVAL = 500
	Default interval.
static const string	DEFAULT_SIMULATION_NAME
	Default simulation name.

---

Detailed Description

ConfigCanvas.

---

Constructor & Destructor Documentation

ConfigCanvas::ConfigCanvas	(	string	name = DEFAULT_SIMULATION_NAME,
		int	cellSize = DEFAULT_CELL_SIZE,
		long	interval = DEFAULT_INTERVAL
	)			[inline, explicit]

Constructor.

Parameters:

	name	Name of the simulation
	cellSize	Starting size of one cell in pixels
	interval	Starting interval between two steps

ConfigCanvas::ConfigCanvas

(

TiXmlElement *

node

)

[explicit]

Constructs object using data from XML node.

virtual ConfigCanvas::~ConfigCanvas

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

TiXmlElement * ConfigCanvas::CreateXmlNode

(

)

const [virtual]

Creates node representing the config.

Implements BaseConfig.

int ConfigCanvas::GetCellSize

(

)

const [inline]

Gets starting cell size.

long ConfigCanvas::GetInterval

(

)

const [inline]

Gets period (interval) between two steps.

const string& ConfigCanvas::GetSimulationName

(

)

const [inline]

Gets simulation name.

void ConfigCanvas::SetSimulationName

(

string

newSimulationName

)

[inline]

Sets new simulation name.

Parameters:

newSimulationName

New simulation name

void ConfigCanvas::ShowEditationWindow	(	wxWindow *	parent,
		bool	waitUntilClosed = true
	)			[virtual]

Shows editation window where the user can edit the config.

Parameters:

	parent	Parent window
	waitUntilClosed	If true, application will be stopped until the window is closed

Implements EditableInWindowConfig.

---

Member Data Documentation

const int ConfigCanvas::DEFAULT_CELL_SIZE = 32 [static, private]

Default cell size.

const long ConfigCanvas::DEFAULT_INTERVAL = 500 [static, private]

Default interval.

const string ConfigCanvas::DEFAULT_SIMULATION_NAME [static, private]

Default simulation name.

string ConfigCanvas::simulationName [private]

Name of the simulation.

int ConfigCanvas::startingCellSize [private]

Size of one cell in the starting view, in pixels.

long ConfigCanvas::startingInterval [private]

Time period between two steps.

---

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

• /home/s3rvac/Projekty/FIT/ICP/ICP07/src/configs/ConfigCanvas.h
• /home/s3rvac/Projekty/FIT/ICP/ICP07/src/configs/ConfigCanvas.cpp

---