GKRealDataSetRestorer Class Reference

Inheritance diagram for GKRealDataSetRestorer:

Public Member Functions
	if (base)
Py_END_ALLOW_THREADS End	GKRealDataSetRestorer ()
	~GKRealDataSetRestorer ()
void	setRealDataSet (GKRealDataSet *arealDataSet)
virtual QString	getName () const =0
virtual QString	getExternalName () const =0
virtual QString	getDescription () const =0
virtual uint	order () const
virtual QString	secondaryOrder () const
const GKType *	getObjectType () const
void	setObjectType (const GKType *type)
virtual bool	restoreData (GKRealDataSet *, GKModel *)
virtual QString	store () const =0
virtual void	restore (GKRealDataSet *, const QString &)=0
virtual GKTimeDuration	getForcedInterval () const
virtual QString	getOriginatorName () const =0

Public Attributes
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKRealDataSetRestorer *	base = (GKRealDataSetRestorer*)sipCpp
	sipType = 0

Detailed Description

See also

GKRealDataSet

Constructor & Destructor Documentation

GKRealDataSetRestorer()

Py_END_ALLOW_THREADS End GKRealDataSetRestorer::GKRealDataSetRestorer

(

)

~GKRealDataSetRestorer()

GKRealDataSetRestorer::~GKRealDataSetRestorer

(

)

Member Function Documentation

getDescription()

virtual QString GKRealDataSetRestorer::getDescription ( ) const

pure virtual

Returns a description of what data can be restored (the file name, the database name...)

Implemented in GKRealDataSetRestorerSimple.

getExternalName()

virtual QString GKRealDataSetRestorer::getExternalName ( ) const

pure virtual

Returns a name for this restorer type to be prsented to the user. It can be localized.

Implemented in GKRealDataSetRestorerSimple.

getForcedInterval()

virtual GKTimeDuration GKRealDataSetRestorer::getForcedInterval ( ) const

virtual

Force an aggregation interval for the data. Set 00:00:00 to turn it off.

Reimplemented in GKRealDataSetRestorerSimple.

getName()

virtual QString GKRealDataSetRestorer::getName ( ) const

pure virtual

Returns a unique name for this restorer type. Usualy will be the class name.

Implemented in GKRealDataSetRestorerSimple.

Referenced by if().

getObjectType()

const GKType * GKRealDataSetRestorer::getObjectType

(

)

const

Type of the objects that will be modified by this restorer. Can be None (any type)

getOriginatorName()

virtual QString GKRealDataSetRestorer::getOriginatorName ( ) const

pure virtual

Implemented in GKRealDataSetRestorerSimple.

if()

GKRealDataSetRestorer::if ( base  )

inline

References base, getName(), GKSystem::getSystem(), and sipType.

order()

virtual uint GKRealDataSetRestorer::order ( ) const

virtual

When a GKRealDataSet contains more than one GKRealDataSetRestorer this method is used to sort the GKRealDataSetRestorer on it and do the restoration in order.

Reimplemented in GKRealDataSetRestorerSimple.

restore()

virtual void GKRealDataSetRestorer::restore ( GKRealDataSet *  , const QString &    )

pure virtual

Restores the object state from a XML string.

Implemented in GKRealDataSetRestorerSimple.

restoreData()

virtual bool GKRealDataSetRestorer::restoreData ( GKRealDataSet *  , GKModel *    )

virtual

Restores the data. Returns true if the data was restored, false otherwise.

Reimplemented in GKRealDataSetRestorerSimple.

secondaryOrder()

virtual QString GKRealDataSetRestorer::secondaryOrder ( ) const

virtual

When a GKRealDataSet contains more than one GKRealDataSetRestorer this method is used to sort the GKRealDataSetRestorer on it and do the restoration in order.

Reimplemented in GKRealDataSetRestorerSimple.

setObjectType()

void GKRealDataSetRestorer::setObjectType

(

const GKType *

type

)

Type of the objects that will be modified by this restorer. Can be None (any type)

setRealDataSet()

void GKRealDataSetRestorer::setRealDataSet

(

GKRealDataSet *

arealDataSet

)

Set the real dataset

store()

virtual QString GKRealDataSetRestorer::store ( ) const

pure virtual

Returns a XML string with this object data (but not the data restored). This data will be stored in the Aimsun datanase.

Implemented in GKRealDataSetRestorerSimple.

Member Data Documentation

base

ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKRealDataSetRestorer* GKRealDataSetRestorer::base = (GKRealDataSetRestorer*)sipCpp

Referenced by if().

sipType

GKRealDataSetRestorer::sipType = 0

Referenced by if().