MIE::JOB_BASE Class Reference

Base for an individual import/export job. More...

#include <mie/jobbase.h>

Inheritance diagram for MIE::JOB_BASE:

[legend]

List of all members.

Public Member Functions
	JOB_BASE (const FORMAT &format, const SETTINGS &settings)
virtual	~JOB_BASE ()
const FORMAT &	GetFormat () const
MISTRING &	GetLog (LOGMSG loglevel=LOGMSG_Info)
LOGMSG	GetLogLevel () const
const RVC::OBJITEM &	GetObjItem () const
RVC::OBJITEM &	GetObjItem ()
const SETTINGS &	GetSettings () const
bool	IsGeometric () const
bool	IsGeospatial () const
ERRVALUE	LogError (ERRVALUE ErrorCode)
void	LogPrint (LOGMSG msglevel, TEXTID textid)
void	LogPrint (LOGMSG msglevel, const MIUNICODE *message)
void	SetLogLevel (LOGMSG level)
void	SetObjItem (const RVC::OBJITEM &objitem)
Protected Member Functions
const TRANS2D_MAPGEN &	GetTransMapGen () const
Protected Attributes
const FORMAT &	m_Format
const SETTINGS &	m_Settings
FILEPATH	m_SourcePath
Private Member Functions
virtual bool	v_IsGeometric () const
virtual bool	v_IsGeospatial () const

---

Detailed Description

Base for an individual import/export job.

---

Constructor & Destructor Documentation

MIE::JOB_BASE::JOB_BASE	(	const FORMAT &	format,
		const SETTINGS &	settings
	)

virtual MIE::JOB_BASE::~JOB_BASE

(

)

[virtual]

---

Member Function Documentation

const FORMAT& MIE::JOB_BASE::GetFormat

(

)

const [inline]

MISTRING& MIE::JOB_BASE::GetLog

(

LOGMSG

loglevel = LOGMSG_Info

)

Return the log string so that you can just << messages into it.

If the loglevel passed in is > he current log level, the current log level is changed.

LOGMSG MIE::JOB_BASE::GetLogLevel

(

)

const [inline]

Get the current log message level log messages below the current level will be ignored.

const RVC::OBJITEM& MIE::JOB_BASE::GetObjItem

(

)

const [inline]

Return the ObjItem for this Job.

RVC::OBJITEM& MIE::JOB_BASE::GetObjItem

(

)

[inline]

Return the ObjItem for this Job.

const SETTINGS& MIE::JOB_BASE::GetSettings

(

)

const [inline]

Return the settings for this job.

const TRANS2D_MAPGEN& MIE::JOB_BASE::GetTransMapGen

(

)

const [inline, protected]

bool MIE::JOB_BASE::IsGeometric

(

)

const [inline]

bool MIE::JOB_BASE::IsGeospatial

(

)

const [inline]

ERRVALUE MIE::JOB_BASE::LogError

(

ERRVALUE

ErrorCode

)

Log an error code.

Returns the value passed in. Assumes you've already done SetErrPosn on the error code

void MIE::JOB_BASE::LogPrint	(	LOGMSG	msglevel,
		TEXTID	textid
	)

Append a message to the log Note: You can also just call GetLog() which returns a non-const reference to an MISTRING and << into that.

void MIE::JOB_BASE::LogPrint	(	LOGMSG	msglevel,
		const MIUNICODE *	message
	)

Append a message to the log Note: You can also just call GetLog() which returns a non-const reference to an MISTRING and << into that.

void MIE::JOB_BASE::SetLogLevel

(

LOGMSG

level

)

[inline]

Set the current log message level.

void MIE::JOB_BASE::SetObjItem

(

const RVC::OBJITEM &

objitem

)

[inline]

Set the objitem for the job.

In the case of Import, this is only to be used in v_ImportEnd if there is some step that has to copy the object from a temp file to the actual destination. (for example, vector optimization or importing to one object type and converting to another)

For export, the objitem passed will be what gets exported for the JOB. This allows you to, for example, extract to a temporary object which is more suited to the format.

virtual bool MIE::JOB_BASE::v_IsGeometric

(

)

const [private, virtual]

virtual bool MIE::JOB_BASE::v_IsGeospatial

(

)

const [private, virtual]

---

Member Data Documentation

const FORMAT& MIE::JOB_BASE::m_Format [protected]

const SETTINGS& MIE::JOB_BASE::m_Settings [protected]

FILEPATH MIE::JOB_BASE::m_SourcePath [protected]

Reimplemented in MIE::JOB_IMPORT.

---

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

• mie/jobbase.h