MIE::JOB_IMPORT Class Reference

Base for an individual import job. More...

#include <mie/jobbase.h>

Inheritance diagram for MIE::JOB_IMPORT:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 JOB_IMPORT (const FORMAT &format, const SETTINGS &settings)
virtual ~JOB_IMPORT ()
ERRVALUE ImportBegin (const RVC::OBJITEM &DestObj)
ERRVALUE ImportEnd (RVC::OBJITEM &DestObj)
bool ImportNeedTempFile () const
void SetSourcePath (const FILEPATH &path)

Protected Member Functions

virtual ERRVALUE v_ImportBegin (const RVC::OBJITEM &DestObj)
virtual ERRVALUE v_ImportEnd (RVC::OBJITEM &DestObj)
virtual bool v_ImportNeedTempFile () const

Protected Attributes

FILEPATH m_SourcePath

Detailed Description

Base for an individual import job.


Constructor & Destructor Documentation

MIE::JOB_IMPORT::JOB_IMPORT ( const FORMAT format,
const SETTINGS settings 
)
virtual MIE::JOB_IMPORT::~JOB_IMPORT (  )  [virtual]

Member Function Documentation

ERRVALUE MIE::JOB_IMPORT::ImportBegin ( const RVC::OBJITEM DestObj  ) 

Does everything needed to prepare to import an object of this type.

Actual implementation depends on derived object type.

ERRVALUE MIE::JOB_IMPORT::ImportEnd ( RVC::OBJITEM DestObj  ) 

Complete the import.

Does things like creating histograms, pyramid tiers, etc. Actual implementation depends on derived object type. DestObj is not const

bool MIE::JOB_IMPORT::ImportNeedTempFile (  )  const [inline]

Determine if the settings for this job will require a temp file file.

void MIE::JOB_IMPORT::SetSourcePath ( const FILEPATH path  )  [inline]

Set the path of the source file for this job.

Should not ever need to call this from actual imports.

virtual ERRVALUE MIE::JOB_IMPORT::v_ImportBegin ( const RVC::OBJITEM DestObj  )  [protected, virtual]

Begin import.

Note, If v_ImportNeedTempFile returns true, then the OBJITEM passed will point to the temp file. Derived class should call base class implementation before doing any of its own implementation

Reimplemented in MIE::JOB_GEOMETRIC, MIE::JOB_GEOSPATIAL, MIE::JOB_HYPERSPECTRAL, MIE::JOB_IMAGE, MIE::JOB_RASTER, and MIE::JOB_VECTOR.

virtual ERRVALUE MIE::JOB_IMPORT::v_ImportEnd ( RVC::OBJITEM DestObj  )  [protected, virtual]

Finish the import.

Note, do not assume that v_ImportBegin was called or that anything else has been done to the job instance. In the case of importing as one object type and then converting to another, the v_ImportEnd will do the copy. Object conversion is done at the lowest possible JOB-derived class from which both the destination and source object type JOB classes are derived. So for example, since both JOB_VECTOR and JOB_CAD derive from JOB_GEOMETRIC, object conversion between them is handled in JOB_GEOMETRIC's v_ImportEnd.

Derived class should call base class implementation after doing its own cleanup.

Reimplemented in MIE::JOB_CAD, MIE::JOB_CAD_LINKABLE, MIE::JOB_GEOMETRIC, MIE::JOB_GEOSPATIAL, MIE::JOB_HYPERSPECTRAL, MIE::JOB_IMAGE, MIE::JOB_RASTER, and MIE::JOB_VECTOR.

virtual bool MIE::JOB_IMPORT::v_ImportNeedTempFile (  )  const [protected, virtual]

Determine if we need to import to a tempfile and then do something to transfer to the real file later.

If this returns true, v_ImportEnd() should copy/extract/convert the object from the temp file to its final home. Derived class should call base class implementation and return true if it says a temp file is needed

Reimplemented in MIE::JOB_CAD, MIE::JOB_CAD_LINKABLE, MIE::JOB_GEOMETRIC, MIE::JOB_RASTER, MIE::JOB_RASTER_LINKABLE, MIE::JOB_SHAPE_LINKABLE, and MIE::JOB_VECTOR.


Member Data Documentation

Reimplemented from MIE::JOB_BASE.


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

Generated on Sun Oct 7 21:36:33 2012 for TNTsdk 2012 by  doxygen 1.6.1