SML::RASTEROBJECT Class Reference

#include <sml/rasterobject.h>

Inheritance diagram for SML::RASTEROBJECT:
Inheritance graph
[legend]

List of all members.

Public Member Functions

int Flush ()
int GetCurCol () const
int GetCurLin () const
DEPRECATED int GetDataType () const
RVC::RASTERGetInterface () const
bool GetNullKnown () const
double GetNullValue () const
DEPRECATED int GetNumBits () const
int GetNumCols () const
int GetNumLins () const
bool GetUseNull () const
void InvalidateImageStats ()
int ReadCell (int lin, int col, double *pval)
double ReadCell (int lin, int col)
void SetCurCol (int col)
void SetCurLin (int lin)
void SetHistoRead (bool known)
void SetInterface (RVC::RASTER *obj)
void SetMaxValue (double val)
void SetMinValue (double val)
void SetNullKnown (bool known)
void SetNullValue (double val)
void SetupRaster ()
void SetUseNull (bool use)
int WriteCell (int lin, int col, double val)
int WriteSpan (int lin, int startcol, int endcol, double val)

Detailed Description

Note:
ctor/dtor are private and only called by friend SML::CONTEXT

Member Function Documentation

int SML::RASTEROBJECT::Flush (  ) 

Flush the internal buffers.

int SML::RASTEROBJECT::GetCurCol (  )  const

Get current column.

int SML::RASTEROBJECT::GetCurLin (  )  const

Get current line.

DEPRECATED int SML::RASTEROBJECT::GetDataType (  )  const

Get the data type (RVCTYPE_Xxx).

RVC::RASTER* SML::RASTEROBJECT::GetInterface (  )  const

Get a pointer to the RVC::RASTER interface class.

Do NOT free this pointer. It will be destroyed when the SML::OBJECT is destroyed. The interface returned is Attached to the object but may or may not be open. If the SML::BOJECT does not refer to any existing real object, this method will return NULL.

bool SML::RASTEROBJECT::GetNullKnown (  )  const

Returns true if the Null value is known (should be named IsNullKnown).

double SML::RASTEROBJECT::GetNullValue (  )  const

Return the raster's NULL value as a double return value undefined if the raster doesn't have a NULL value.

DEPRECATED int SML::RASTEROBJECT::GetNumBits (  )  const

Returns the number of bits/cell.

int SML::RASTEROBJECT::GetNumCols (  )  const

Returns the number of raster columns.

int SML::RASTEROBJECT::GetNumLins (  )  const

Returns the number of raster lines.

bool SML::RASTEROBJECT::GetUseNull (  )  const

Returns true if the NULL cells are being treated as NULL Returns false if NULL cells are being treated as normal values.

void SML::RASTEROBJECT::InvalidateImageStats (  ) 

Force a re-read of the histogram the next time GetImageStats() is called.

int SML::RASTEROBJECT::ReadCell ( int  lin,
int  col,
double *  pval 
)

Read a single raster cell.

double SML::RASTEROBJECT::ReadCell ( int  lin,
int  col 
)

Reads the cell value at a given location Sets ErrorCode if fatal error.

void SML::RASTEROBJECT::SetCurCol ( int  col  ) 

Set the current column (used by foreach loops).

void SML::RASTEROBJECT::SetCurLin ( int  lin  ) 

Set the current line (used by foreach loops).

void SML::RASTEROBJECT::SetHistoRead ( bool  known  ) 

Set whether or not histogram has been read.

void SML::RASTEROBJECT::SetInterface ( RVC::RASTER obj  ) 

Set a pointer to the RVC::RASTER interface class.

After setting the interface, the SML::OBJECT "owns" it and will delete it in its own destructor. Do not under any circumstances pass a pointer to an local variable that will go out of scope. Since SML::OBJECT is implemented in rvcsys.dll it does not have have access to the copy constructor.

void SML::RASTEROBJECT::SetMaxValue ( double  val  ) 
void SML::RASTEROBJECT::SetMinValue ( double  val  ) 
void SML::RASTEROBJECT::SetNullKnown ( bool  known  ) 
void SML::RASTEROBJECT::SetNullValue ( double  val  ) 
void SML::RASTEROBJECT::SetupRaster (  ) 
void SML::RASTEROBJECT::SetUseNull ( bool  use  ) 
int SML::RASTEROBJECT::WriteCell ( int  lin,
int  col,
double  val 
)

Write a single raster cell.

int SML::RASTEROBJECT::WriteSpan ( int  lin,
int  startcol,
int  endcol,
double  val 
)

Write a span of raster cells all the same value.


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

Generated on Sun Oct 7 21:39:17 2012 for TNTsdk 2012 by  doxygen 1.6.1