MIE::JOB_RASTER Class Reference

#include <mie/raster.h>

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

List of all members.

Public Member Functions

 JOB_RASTER (const FORMAT &format, const SETTINGS &settings)
virtual ~JOB_RASTER ()
void GetMakeParms (RVC::RASTER::MAKEPARMS &makeparms) const
RVC::RASTERGetRastObj ()
int GetTileColumns () const
int GetTileLines () const
INT64 ImportGenericComputeBandSize () const
ERRVALUE MakeRaster ()
ERRVALUE MakeRaster (RVC::RASTER::MAKEPARMS &makeparms)
ERRVALUE WriteRaster (INT32 Line, INT32 StartColumn, void *data, INT32 Length=1, RVC::IMAGE::CONVMODE Convert=RVC::IMAGE::CONVMODE_None, RVC::RASTER::COMPONENT Component=RVC::RASTER::COMPONENT_Default)

Protected Member Functions

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

Private Attributes

RVC::RASTER m_RastObj

Constructor & Destructor Documentation

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

Member Function Documentation

void MIE::JOB_RASTER::GetMakeParms ( RVC::RASTER::MAKEPARMS makeparms  )  const

Setup a MAKEPARMS based on current SETTINGS and values in the JOB (this), preferring values from the JOB.

RVC::RASTER& MIE::JOB_RASTER::GetRastObj (  )  [inline]
int MIE::JOB_RASTER::GetTileColumns (  )  const
int MIE::JOB_RASTER::GetTileLines (  )  const
INT64 MIE::JOB_RASTER::ImportGenericComputeBandSize (  )  const

Compute the size (in bytes) of a single band.

ERRVALUE MIE::JOB_RASTER::MakeRaster (  ) 

Make the raster.

This version calls GetMakeParms to get the default makeparms based on values in SETTINGS and the JOB (this), giving preference to JOB's values.

ERRVALUE MIE::JOB_RASTER::MakeRaster ( RVC::RASTER::MAKEPARMS makeparms  ) 

Make the raster.

If you call this version, be sure to call GetMakeParms to initialize your MAKEPARMS to whatever the SETTINGS has setup. From there you can modify it before calling make.

virtual ERRVALUE MIE::JOB_RASTER::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 from MIE::JOB_IMAGE.

virtual ERRVALUE MIE::JOB_RASTER::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, then allocate a JOB for the destination and just call its v_ImportEnd. This allows importing to CAD, converting to vector, and then calling vector's v_ImportEnd to optimize or create standard attribute tables. (although CAD's ExtractToVector should optimize for us?) Derived class should call base class implementation after doing its own cleanup

Reimplemented from MIE::JOB_IMAGE.

virtual ERRVALUE MIE::JOB_RASTER::v_ImportGeneric ( const FILEPATH filepath  )  [protected, virtual]

Generic raster import.

Produces one output raster. The job's OBJITEM and RASTER will reference this raster when finished.

Need to set raster information in job before calling this (e.g. number of lines / columns, number of bits). If needed RVC::IMAGE members are not set, will use values from from settings if appropriate.

Note: if settings.GetDoLink() is true, this method will produce a linked raster object. Otherwise, it will make a new raster. Therefore, it is not advisable to derive your FORMAT from FORMAT_LINKABLE if you are going to use this method, since it assumes v_Import always produces a linked raster.

Implements MIE::JOB_IMAGE.

virtual bool MIE::JOB_RASTER::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 from MIE::JOB_IMPORT.

Reimplemented in MIE::JOB_RASTER_LINKABLE.

ERRVALUE MIE::JOB_RASTER::WriteRaster ( INT32  Line,
INT32  StartColumn,
void *  data,
INT32  Length = 1,
RVC::IMAGE::CONVMODE  Convert = RVC::IMAGE::CONVMODE_None,
RVC::RASTER::COMPONENT  Component = RVC::RASTER::COMPONENT_Default 
)

Write a line to the raster object.

Will modify data if needed in order to write to output raster.


Member Data Documentation


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