TdkProject Class Reference
[The Core Module]

Defines the class TdkProject. More...

#include <TdkProject.h>

Inheritance diagram for TdkProject:

List of all members.

virtual void	loadChildren (TeDatabase *dbCaller, TdkLoadParams &params)
	TdkProject ()
	Default constructor.
	TdkProject (const TdkObjectGID &objectGID)
	Default constructor. Using TdkObject.
	TdkProject (TdkProject &proj)
	Copy constructor.
	TdkProject (TdkObjectGID objectGID, std::string name, std::string desc)
	Basic constructor, only creates and sets attributes of the object.
	TdkProject (std::string name, std::string desc)
	Basic constructor, only creates and sets attributes of the object.
virtual void	import (TdkObject &object)
virtual void	operator= (TdkObject &object)
virtual TdkObject *	copy ()
	Creates a copy of the object.
virtual bool	isProjectView (TdkObjectGID &viewGID)
	Returns TRUE if a view is part of a project and FALSE otherwise.
virtual void	setCurrentViewGID (TdkObjectGID &viewGID)
	Sets the index of the current map of the project (it must be one of the project's maps).
virtual TdkObjectGID	getCurrentViewGID ()
	Returns a pointer to the current map of the project.
virtual void	addViewGID (TdkObjectGID &viewGID)
	Adds an existing view to the project.
virtual TdkObjectGID	getViewGID (int index)
	Returns a pointer to the i-th map of the project.
virtual void	setDatabase (TeDatabase *db)
virtual void	reloadViews ()
virtual void	updateView ()
virtual void	fillThemeCollectionTables ()
virtual std::string	getStringAttr (std::string attr_name)
	Returns the value for the given attribute. The attribute type must be string.
virtual void	setStringAttr (std::string attr_name, std::string value)
	Sets the value for the given attribute. The attribute type must be string.
Protected Member Functions
virtual bool	load (TeDatabase *dbCaller, TdkLoadParams &params)
	Updates the object in the database.
virtual void	remove (TeDatabase *dbCaller)
virtual bool	insert (TeDatabase *dbCaller, TdkPersistenceParams &params)
	Inserts the object in the database.
virtual bool	update (TeDatabase *dbCaller, TdkPersistenceParams &params)
	Updates the object in the database.
Friends
class	TeDatabase

---

Detailed Description

Defines the class TdkProject.

This class represents a project(a set of views) stored in a database.

---

Constructor & Destructor Documentation

TdkProject::TdkProject

(

)

Default constructor.

TdkProject::TdkProject

(

const TdkObjectGID &

objectGID

)

Default constructor. Using TdkObject.

TdkProject::TdkProject

(

TdkProject &

proj

)

Copy constructor.

TdkProject::TdkProject	(	TdkObjectGID	objectGID,
		std::string	name,
		std::string	desc
	)

Basic constructor, only creates and sets attributes of the object.

TdkProject::TdkProject	(	std::string	name,
		std::string	desc
	)

Basic constructor, only creates and sets attributes of the object.

---

Member Function Documentation

bool TdkProject::load	(	TeDatabase *	dbCaller,
		TdkLoadParams &	params
	)			[protected, virtual]

Updates the object in the database.

@ name Database caller these methods are called by the database driver associated to the project.

Reimplemented from TdkObjectCollection.

void TdkProject::remove

(

TeDatabase *

dbCaller

)

[protected, virtual]

bool TdkProject::insert	(	TeDatabase *	dbCaller,
		TdkPersistenceParams &	params
	)			[protected, virtual]

Inserts the object in the database.

Reimplemented from TdkObjectCollection.

bool TdkProject::update	(	TeDatabase *	dbCaller,
		TdkPersistenceParams &	params
	)			[protected, virtual]

Updates the object in the database.

Reimplemented from TdkObjectCollection.

void TdkProject::loadChildren	(	TeDatabase *	dbCaller,
		TdkLoadParams &	params
	)			[protected, virtual]

Reimplemented from TdkObjectCollection.

void TdkProject::import

(

TdkObject &

object

)

[virtual]

Reimplemented from TdkObjectCollection.

void TdkProject::operator=

(

TdkObject &

object

)

[virtual]

Reimplemented from TdkObjectCollection.

TdkObject * TdkProject::copy

(

)

[virtual]

Creates a copy of the object.

Reimplemented from TdkObjectCollection.

bool TdkProject::isProjectView

(

TdkObjectGID &

viewGID

)

[virtual]

Returns TRUE if a view is part of a project and FALSE otherwise.

void TdkProject::setCurrentViewGID

(

TdkObjectGID &

viewGID

)

[virtual]

Sets the index of the current map of the project (it must be one of the project's maps).

TdkObjectGID TdkProject::getCurrentViewGID

(

)

[virtual]

Returns a pointer to the current map of the project.

void TdkProject::addViewGID

(

TdkObjectGID &

viewGID

)

[virtual]

Adds an existing view to the project.

TdkObjectGID TdkProject::getViewGID

(

int

index

)

[virtual]

Returns a pointer to the i-th map of the project.

void TdkProject::setDatabase

(

TeDatabase *

db

)

[virtual]

Sets the vector of the maps identifiers in the project.

void TdkProject::reloadViews

(

)

[virtual]

Reloads all the maps from the database.

Returns:

If success returns true otherwise returns false.

void TdkProject::updateView

(

)

[virtual]

Saves everything that was modified in the current map.

void TdkProject::fillThemeCollectionTables

(

)

[virtual]

Fills the collection table relative to the current view (not used by Tdk anymore).

Returns:

If success returns true otherwise returns false.

std::string TdkProject::getStringAttr

(

std::string

attr_name

)

[virtual]

Returns the value for the given attribute. The attribute type must be string.

Reimplemented from TdkObjectCollection.

void TdkProject::setStringAttr	(	std::string	attr_name,
		std::string	value
	)			[virtual]

Sets the value for the given attribute. The attribute type must be string.

Reimplemented from TdkObjectCollection.

---

Friends And Related Function Documentation

friend class TeDatabase [friend]

---

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

• D:/usuarios/rodrigof/svn/tdk/src/peer/components/core/TdkProject.h
• D:/usuarios/rodrigof/svn/tdk/src/peer/components/core/TdkProject.cpp

---