GEOFORMULA Class Reference

Geospatial Formula class. More...

#include <mi32/geofrmla.h>

Classes
class	EDITOR
	GEOFORMULA::EDITOR. More...
class	OBJECT
	GEOFORMULA::OBJECT. More...
class	RASTER
	GEOFORMULA::RASTER. More...
class	TIN
	End of GEOFORMULA::VECTOR. More...
class	VALUE
	GEOFORMULA::VALUE. More...
class	VECTOR
	GEOFORMULA::VECTOR. More...
Public Types
enum	EXTENTSMODE { EXTENTSMODE_UserDefined = 0, EXTENTSMODE_Intersection = 1, EXTENTSMODE_Union = 2, EXTENTSMODE_Region = 3 }
enum	OUTPUTTYPE { OUTPUTTYPE_Numeric = 0, OUTPUTTYPE_Color = 1 }
enum	SCRIPTFLAGS { SCRIPTFLAG_None = 0x00, SCRIPTFLAG_AllSymbols = 0x01, SCRIPTFLAG_NoParse = 0x02 }
Public Member Functions
	GEOFORMULA (const GEOFORMULA &rhs)
	GEOFORMULA ()
	~GEOFORMULA ()
ERRVALUE	AddValue (const MIUNICODE *SymbolName, double value)
ERRVALUE	CreateFromObjects (const RVC::OBJITEMLIST &objitems)
ERRVALUE	DlgSelectExtentsRegion (MDLGPARENT dlgparent, const REGION2D *testregion=0)
ERRVALUE	DlgSelectObjects (MDLGPARENT dlgparent)
ERRVALUE	Evaluate (const DPOINT2D &start, const DPOINT2D &increment, INT32 numvals, void buffer, UINT8 omask)
const REGION2D &	GetExtMapRegion () const
ERRVALUE	GetFirstObjectCoordRefSys (SPATREF::COORDREFSYS &CoordRefSys) const
ERRVALUE	GetMinRasterCellSize (double &MinCellSize) const
int	GetNumObjects () const
const MILIST< RASTER > &	GetObjectListRaster () const
const MILIST< TIN > &	GetObjectListTIN () const
const MILIST< VECTOR > &	GetObjectListVector () const
void	GetObjItems (RVC::OBJITEMLIST &objitems)
OUTPUTTYPE	GetOutputType () const
const MISTRING &	GetScript () const
ERRVALUE	GetTransToExtCRS (TRANS2D_MAPGEN &Trans, bool dooutput=false) const
ERRVALUE	OpenObjects ()
GEOFORMULA &	operator= (const GEOFORMULA &rhs)
ERRVALUE	ReadDefn (const FILEPATH &filepath)
ERRVALUE	SerialRead (SERIALIZER &serializer)
ERRVALUE	SerialWrite (SERIALIZER &serializer, const char *tagname=0)
void	SetExtMapCoordRefSys (const SPATREF::COORDREFSYS &CoordRefSys)
ERRVALUE	SetObjItems (const RVC::OBJITEMLIST &objitems)
void	SetOutputCoordRefSys (const SPATREF::COORDREFSYS &CoordRefSys)
void	SetOutputTrans (const TRANS2D_MAPGEN &trans)
void	SetOutputTrans (const TRANS2D_AFFINE &trans)
void	SetOutputTrans (const MAT3X3 fwd, const MAT3X3 inv)
void	SetOutputTransIdentity ()
void	SetOutputType (OUTPUTTYPE OutputType)
void	SetScript (const MIUNICODE *script)
ERRVALUE	Start (const DRECT2D *extents, SCRIPTFLAGS flags=SCRIPTFLAG_None)
void	Stop ()
ERRVALUE	WriteDefn (const FILEPATH &filepath)

Detailed Description

Geospatial Formula class.

Member Enumeration Documentation

enum GEOFORMULA::EXTENTSMODE

Mode for determining extents.

Enumerator:

EXTENTSMODE_UserDefined
EXTENTSMODE_Intersection
EXTENTSMODE_Union
EXTENTSMODE_Region

enum GEOFORMULA::OUTPUTTYPE

Output type of formula.

Enumerator:

OUTPUTTYPE_Numeric
OUTPUTTYPE_Color

enum GEOFORMULA::SCRIPTFLAGS

Enumerator:

SCRIPTFLAG_None
SCRIPTFLAG_AllSymbols
SCRIPTFLAG_NoParse

Constructor & Destructor Documentation

GEOFORMULA::GEOFORMULA ( )

Default constructor.

GEOFORMULA::GEOFORMULA ( const GEOFORMULA & rhs )

Copy constructor.

GEOFORMULA::~GEOFORMULA ( )

Destructor.

Member Function Documentation

ERRVALUE GEOFORMULA::AddValue	(	const MIUNICODE *	SymbolName,
		double	value
	)

Add new "value" symbol to formula.

Parameters:

	SymbolName	Symbol name
	value	Initial value

ERRVALUE GEOFORMULA::CreateFromObjects ( const RVC::OBJITEMLIST & objitems )

Create new formula from specified list of objects.

ERRVALUE GEOFORMULA::DlgSelectExtentsRegion	(	MDLGPARENT	dlgparent,
		const REGION2D *	testregion = `0`
	)

Display dialog allowing user to select region for extents.

Parameters:

testregion

Region to test for overlap with, 0 to allow all regions

ERRVALUE GEOFORMULA::DlgSelectObjects ( MDLGPARENT dlgparent )

Display dialog allowing user to select specific objects to use.

ERRVALUE GEOFORMULA::Evaluate	(	const DPOINT2D &	start,
		const DPOINT2D &	increment,
		INT32	numvals,
		void *	buffer,
		UINT8 *	omask
	)

Evaluate formula for points along specified interval.

const REGION2D& GEOFORMULA::GetExtMapRegion ( ) const [inline]

Get extents region.

ERRVALUE GEOFORMULA::GetFirstObjectCoordRefSys ( SPATREF::COORDREFSYS & CoordRefSys ) const

Get coordinate reference system of first object used in formula (for auto-match).

Parameters:

CoordRefSys

Coordinate Reference System returned

ERRVALUE GEOFORMULA::GetMinRasterCellSize ( double & MinCellSize ) const

Get minimum cell size for all rasters used in formula.

Parameters:

MinCellSize

Cell size returned, DBL_MAX if no rasters in formula

int GEOFORMULA::GetNumObjects ( ) const [inline]

Get number of objects used in formula.

const MILIST<RASTER>& GEOFORMULA::GetObjectListRaster ( ) const [inline]

Get raster object list.

const MILIST<TIN>& GEOFORMULA::GetObjectListTIN ( ) const [inline]

Get TIN object list.

const MILIST<VECTOR>& GEOFORMULA::GetObjectListVector ( ) const [inline]

Get vector object list.

void GEOFORMULA::GetObjItems ( RVC::OBJITEMLIST & objitems )

Get objitem list.

OUTPUTTYPE GEOFORMULA::GetOutputType ( ) const [inline]

Get formula output type.

const MISTRING& GEOFORMULA::GetScript ( ) const [inline]

Get formula script.

ERRVALUE GEOFORMULA::GetTransToExtCRS	(	TRANS2D_MAPGEN &	Trans,
		bool	dooutput = `false`
	)			const

Get transformation from virtual formula object to extents CRS.

Parameters:

	Trans	Transformation returned
	dooutput	Place in output size of transformation

ERRVALUE GEOFORMULA::OpenObjects ( )

Open objects to use in formula.

GEOFORMULA& GEOFORMULA::operator= ( const GEOFORMULA & rhs )

Assignment.

ERRVALUE GEOFORMULA::ReadDefn ( const FILEPATH & filepath )

Read previously saved formula definition.

ERRVALUE GEOFORMULA::SerialRead ( SERIALIZER & serializer )

Read from serialization.

ERRVALUE GEOFORMULA::SerialWrite	(	SERIALIZER &	serializer,
		const char *	tagname = `0`
	)

Write to serialization.

void GEOFORMULA::SetExtMapCoordRefSys ( const SPATREF::COORDREFSYS & CoordRefSys ) [inline]

Set coordinate reference system for defining extents.

ERRVALUE GEOFORMULA::SetObjItems ( const RVC::OBJITEMLIST & objitems )

Set objitem list, must be created first.

void GEOFORMULA::SetOutputCoordRefSys ( const SPATREF::COORDREFSYS & CoordRefSys ) [inline]

Set output coordinate reference system.

void GEOFORMULA::SetOutputTrans ( const TRANS2D_MAPGEN & trans ) [inline]

Set output transformation from "output side" of a TRANS2D_MAPGEN reference.

void GEOFORMULA::SetOutputTrans ( const TRANS2D_AFFINE & trans ) [inline]

Set transformation from output object to map coordinates.

void GEOFORMULA::SetOutputTrans	(	const MAT3X3	fwd,
		const MAT3X3	inv
	)			`[inline]`

Set transformation from output object to map coordinates.

void GEOFORMULA::SetOutputTransIdentity ( ) [inline]

Set transformation from output object to map coordinates.

void GEOFORMULA::SetOutputType ( OUTPUTTYPE OutputType ) [inline]

Set formula output type.

void GEOFORMULA::SetScript ( const MIUNICODE * script ) [inline]

Set script to use in formula.

ERRVALUE GEOFORMULA::Start	(	const DRECT2D *	extents,
		SCRIPTFLAGS	flags = `SCRIPTFLAG_None`
	)

Start formula evaluation.

void GEOFORMULA::Stop ( )

Stop formula evaluation.

ERRVALUE GEOFORMULA::WriteDefn ( const FILEPATH & filepath )

Write formula definition to specified file.

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

mi32/geofrmla.h

GEOFORMULA Class Reference

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation