GKRealDataSetRestorerSimple Class Reference

Inheritance diagram for GKRealDataSetRestorerSimple:

Public Types
enum	IdType { eById , eByName , eByExternalId }
enum	TimeType {   eDateTimeISO , eDateTimeLocal , eTimeAbsoluteHHMMSS , eTimeRelativeHHMMSS ,   eTimeAbsoluteSS , eTimeRelativeSS }
enum	DecimalSeparator { eSystem = 0 , eDot = 1 , eComma = 2 }

Public Member Functions
	GKRealDataSetRestorerSimple ()
virtual QString	getName () const
virtual QString	getExternalName () const
virtual QString	getDescription () const
virtual uint	order () const
virtual QString	secondaryOrder () const
virtual QString	getOriginatorName () const
bool	restoreData (GKRealDataSet *arealDataSet, GKModel *amodel)
virtual QString	store () const
virtual void	restore (GKRealDataSet *arealDataSet, const QString &xmlData)
const QString &	getFileName () const
void	setFileName (const QString &aname)
bool	getUseFileNameAsId () const
void	setUseFileNameAsId (bool value)
IdType	getIdType () const
void	setIdType (IdType value)
TimeType	getTimeType () const
void	setTimeType (TimeType value)
GK::UnitSystem	getUnits () const
void	setUnits (GK::UnitSystem value)
QChar	getSeparator () const
void	setSeparator (QChar value)
GKRealDataSetRestorerSimple::DecimalSeparator	getDecimalSeparator () const
void	setDecimalSeparator (DecimalSeparator value)
QDateTime	getBaseDate () const
void	setBaseDate (const QDateTime &value)
const QVector< GKRealDataSet::ColType > &	getColumns () const
void	clearColumns ()
void	setColumns (const QVector< GKRealDataSet::ColType > &value)
const QVector< QString > &	getVehicles () const
void	clearVehicles ()
void	setVehicles (const QVector< QString > &value)
void	setForcedInterval (const GKTimeDuration &newInterval)
GKTimeDuration	getForcedInterval () const
void	setLinesToSkip (int nbLines)
int	getLinesToSkip () const
Public Member Functions inherited from GKRealDataSetRestorer
	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

Additional Inherited Members
Public Attributes inherited from GKRealDataSetRestorer
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKRealDataSetRestorer *	base = (GKRealDataSetRestorer*)sipCpp
	sipType = 0

Detailed Description

This object restores data from an ascii file. When restored, a new column is created in the referenced type and the data is loaded for each referenced object

Member Enumeration Documentation

DecimalSeparator

enum GKRealDataSetRestorerSimple::DecimalSeparator

Enumerator
eSystem
eDot
eComma

IdType

enum GKRealDataSetRestorerSimple::IdType

Object Identifier: eById: Internal Object ID eByName: Object Name eByExternalId: Object external ID

Enumerator
eById
eByName
eByExternalId

TimeType

enum GKRealDataSetRestorerSimple::TimeType

Time representation types eDateTimeISO: ISO 8601 extended format (YYYY-MM-DD, or with time, YYYY-MM-DDTHH:MM:SS) eDateTimeLocal: the format used by the operating system eTimeAbsoluteHHMMSS: HHMMSS and HMMSS formats are allowed. Base time is not taken into account. eTimeRelativeHHMMSS: HHMMSS and HMMSS formats are allowed. The time is relative to the base time eTimeAbsoluteSS: Absolute time in seconds eTimeRelativeSS: Time relative to base time in seconds.

Enumerator
eDateTimeISO
eDateTimeLocal
eTimeAbsoluteHHMMSS
eTimeRelativeHHMMSS
eTimeAbsoluteSS
eTimeRelativeSS

Constructor & Destructor Documentation

GKRealDataSetRestorerSimple()

GKRealDataSetRestorerSimple::GKRealDataSetRestorerSimple

(

)

Member Function Documentation

clearColumns()

void GKRealDataSetRestorerSimple::clearColumns

(

)

Removes all columns to restore.

clearVehicles()

void GKRealDataSetRestorerSimple::clearVehicles

(

)

Clears all the vehicle types.

getBaseDate()

QDateTime GKRealDataSetRestorerSimple::getBaseDate

(

)

const

Returns the Base Date. It is only relevant on Relative Time types.

getColumns()

const QVector< GKRealDataSet::ColType > & GKRealDataSetRestorerSimple::getColumns

(

)

const

Returns the columns types to restore.

getDecimalSeparator()

GKRealDataSetRestorerSimple::DecimalSeparator GKRealDataSetRestorerSimple::getDecimalSeparator

(

)

const

Returns the decimal value separator: System, comma, dot.

getDescription()

virtual QString GKRealDataSetRestorerSimple::getDescription ( ) const

virtual

Reimplemented from GKRealDataSetRestorer.

Implements GKRealDataSetRestorer.

getExternalName()

virtual QString GKRealDataSetRestorerSimple::getExternalName ( ) const

virtual

Reimplemented from GKRealDataSetRestorer.

Implements GKRealDataSetRestorer.

getFileName()

const QString & GKRealDataSetRestorerSimple::getFileName

(

)

const

Returns the file name, which contains the data.

getForcedInterval()

GKTimeDuration GKRealDataSetRestorerSimple::getForcedInterval ( ) const

virtual

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

Reimplemented from GKRealDataSetRestorer.

getIdType()

IdType GKRealDataSetRestorerSimple::getIdType

(

)

const

Returns the type id, used to find the objects.

getLinesToSkip()

int GKRealDataSetRestorerSimple::getLinesToSkip

(

)

const

Returns the number of Lines that the reader will ignore at the beggining of the file.

getName()

virtual QString GKRealDataSetRestorerSimple::getName ( ) const

virtual

Reimplemented from GKRealDataSetRestorer.

Implements GKRealDataSetRestorer.

getOriginatorName()

virtual QString GKRealDataSetRestorerSimple::getOriginatorName ( ) const

virtual

Reimplemented from GKRealDataSetRestorer.

Implements GKRealDataSetRestorer.

getSeparator()

QChar GKRealDataSetRestorerSimple::getSeparator

(

)

const

Returns the data field separator: Space, TAB, Comma.

getTimeType()

TimeType GKRealDataSetRestorerSimple::getTimeType

(

)

const

Returns the time definition type.

getUnits()

GK::UnitSystem GKRealDataSetRestorerSimple::getUnits

(

)

const

Returns the units of file contents, English or Metric.

getUseFileNameAsId()

bool GKRealDataSetRestorerSimple::getUseFileNameAsId

(

)

const

Returns whether the file name is an object identifier or not.

getVehicles()

const QVector< QString > & GKRealDataSetRestorerSimple::getVehicles

(

)

const

Returns the vehicle types for all rows.

order()

virtual uint GKRealDataSetRestorerSimple::order ( ) const

virtual

Reimplemented from GKRealDataSetRestorer.

Reimplemented from GKRealDataSetRestorer.

restore()

virtual void GKRealDataSetRestorerSimple::restore ( GKRealDataSet *  arealDataSet, const QString &  xmlData  )

virtual

Reimplemented from GKRealDataSetRestorer.

Implements GKRealDataSetRestorer.

restoreData()

bool GKRealDataSetRestorerSimple::restoreData ( GKRealDataSet *  arealDataSet, GKModel *  amodel  )

virtual

Reimplemented from GKRealDataSetRestorer.

Reimplemented from GKRealDataSetRestorer.

secondaryOrder()

virtual QString GKRealDataSetRestorerSimple::secondaryOrder ( ) const

virtual

Reimplemented from GKRealDataSetRestorer.

Reimplemented from GKRealDataSetRestorer.

setBaseDate()

void GKRealDataSetRestorerSimple::setBaseDate

(

const QDateTime &

value

)

Sets the Base Date. It is only relevant on Relative Time types.

setColumns()

void GKRealDataSetRestorerSimple::setColumns

(

const QVector< GKRealDataSet::ColType > &

value

)

Sets the columns types to restore.

setDecimalSeparator()

void GKRealDataSetRestorerSimple::setDecimalSeparator

(

DecimalSeparator

value

)

Sets the decimal value separator: System, comma, dot.

setFileName()

void GKRealDataSetRestorerSimple::setFileName

(

const QString &

aname

)

Sets the file name, which contains the data.

setForcedInterval()

void GKRealDataSetRestorerSimple::setForcedInterval

(

const GKTimeDuration &

newInterval

)

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

setIdType()

void GKRealDataSetRestorerSimple::setIdType

(

IdType

value

)

Sets the type id, used to find the objects.

setLinesToSkip()

void GKRealDataSetRestorerSimple::setLinesToSkip

(

int

nbLines

)

Sets the umber of Lines that the reader will ignore at the beggining of the file.

setSeparator()

void GKRealDataSetRestorerSimple::setSeparator

(

QChar

value

)

Sets the data field separator: Space, TAB, Comma.

setTimeType()

void GKRealDataSetRestorerSimple::setTimeType

(

TimeType

value

)

Sets the time definition type.

setUnits()

void GKRealDataSetRestorerSimple::setUnits

(

GK::UnitSystem

value

)

Sets the units of file contents, English or Metric.

setUseFileNameAsId()

void GKRealDataSetRestorerSimple::setUseFileNameAsId

(

bool

value

)

Sets whether the file name is an object identifier or not.

setVehicles()

void GKRealDataSetRestorerSimple::setVehicles

(

const QVector< QString > &

value

)

Sets the vehicle types for all rows.

store()

virtual QString GKRealDataSetRestorerSimple::store ( ) const

virtual

Reimplemented from GKRealDataSetRestorer.

Implements GKRealDataSetRestorer.