MIE::SETTINGS Class Reference

MIE::SETTINGS - all the parameters necessary to do an import or export. More...

#include <mie/settings.h>

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

List of all members.

Public Types

enum  NULLCELLMODE {
  NULLCELL_FromSource, NULLCELL_Zero, NULLCELL_Min, NULLCELL_Max,
  NULLCELL_UserDefined
}

Public Member Functions

 SETTINGS (const FORMAT &format, MODE mode, OBJTYPEFLAG ObjType=OBJTYPEFLAG_ALL)
virtual ~SETTINGS ()
void ClearLinColRange ()
bool GetAssignLabelsToPolys () const
bool GetByteOrderMSBFirst () const
bool GetCanChangeMultiSingle () const
bool GetCanDoMultiLink () const
bool GetCanLink () const
RVC::IMAGE::CELLTYPE GetCellType () const
RVC::IMAGE::CELLTYPE GetCellTypesAllowed () const
CHAR_ENCODING GetCharEncoding () const
double GetColScale () const
int GetCompressionLevel () const
RVC::RASTER::COMPTYPE GetCompressionType () const
const SPATREF::COORDREFSYSGetCoordRefSys () const
bool GetCreateElementIDTables () const
bool GetCreateStdAttribTables () const
bool GetDoContrast () const
bool GetDoHistogram () const
bool GetDoHypercube () const
bool GetDoLink () const
bool GetDoMultiLink () const
bool GetDoOptimize () const
bool GetDoSingleFile () const
bool GetDoSurfaceProperties () const
const SPATREF::COORDREFSYSGetExtentsCoordRefSys () const
const TRANS2D_MAPGENGetExtentsTrans () const
RVC::GEOMETRIC::ELEMSELECTPARMS::EXTRACT GetExtractRegionTest () const
bool GetFlipHorz () const
bool GetFlipVert () const
const FORMATGetFormat () const
GEOREFTYPE GetGeorefTypes () const
GEOREFTYPE GetGeorefTypeSelected () const
INT32 GetInitCol () const
INT32 GetInitLin () const
bool GetInvertBW () const
INT32 GetLastCol () const
INT32 GetLastLin () const
bool GetLinkTables () const
double GetLinScale () const
MODE GetMode () const
NULLCELLMODE GetNullExportMode () const
double GetNullValue () const
int GetNumBands () const
UINT32 GetNumCols () const
UINT32 GetNumLins () const
RVC::OBJTYPE GetObjType () const
OBJTYPEFLAG GetObjTypeFlag () const
bool GetOverrideCRS () const
RVC::IMAGE::PYRAMID GetPyramidFlags () const
bool GetSaveProj () const
ERRVALUE GetSchema (XMLNODE *ParentNode) const
bool GetSeparateBands () const
RVC::VECTOR::TOPOLOGYTYPE GetTopologyType () const
bool GetUseNullValue () const
const DRECT3DGetUserExtents () const
ERRVALUE GetValues (XMLNODE *ParentNode) const
double GetXShift () const
double GetYShift () const
int GetZUnits () const
bool HasByteOrder () const
bool HasCellSize () const
bool HasCellType () const
bool HasCRS () const
bool HasInitCol () const
bool HasInitLin () const
bool HasLastCol () const
bool HasLastLin () const
bool HasLinCol () const
bool HasNonRandomAccessTables () const
bool HasNullValue () const
bool HasNumBands () const
bool HasValidExtents () const
bool Is3D () const
bool IsSafeToExport () const
bool IsSafeToImport () const
ERRVALUE ReadParmsIni ()
void SetAssignLabelsToPolys (bool AssignLabelsToPolys)
void SetByteOrderMSBFirst (bool value, bool bHasValue=true)
void SetCanChangeMultiSingle (bool value=true)
void SetCanDoMultiLink (bool value=true)
void SetCanLink (bool value=true)
void SetCellSize (double linscale, double colscale, bool bHasValue=true)
void SetCellType (RVC::IMAGE::CELLTYPE celltype, bool bHasValue=true)
void SetCellTypesAllowed (RVC::IMAGE::CELLTYPE value)
void SetCharEncoding (CHAR_ENCODING value)
void SetCompressionLevel (int value)
void SetCompressionType (RVC::RASTER::COMPTYPE type)
void SetCoordRefSys (const SPATREF::COORDREFSYS &crs)
void SetCreateElementIDTables (bool val=true)
void SetCreateStdAttribTables (bool val=true)
void SetDoContrast (bool val=false)
void SetDoHistogram (bool val=true)
void SetDoHypercube (bool val=true)
void SetDoLink (bool val=true)
void SetDoMultiLink (bool val=true)
void SetDoOptimize (bool val=true)
void SetDoSingleFile (bool val=true)
void SetDoSurfaceProperties (bool DoSurface=true)
void SetExtentsCoordRefSys (const SPATREF::COORDREFSYS &crs)
void SetExtractRegionTest (RVC::GEOMETRIC::ELEMSELECTPARMS::EXTRACT val)
void SetFlipHorz (bool value)
void SetFlipVert (bool value)
void SetGeorefTypes (GEOREFTYPE types)
void SetGeorefTypeSelected (GEOREFTYPE type)
void SetHasLinCol (bool value=true)
void SetHasNonRandomAccessTables (bool value=true)
void SetInitCol (INT32 value, bool bHasValue=true)
void SetInitLin (INT32 value, bool bHasValue=true)
void SetInvertBW (bool value)
void SetIs3D (bool val)
void SetLastCol (INT32 value, bool bHasValue=true)
void SetLastLin (INT32 value, bool bHasValue=true)
void SetLinkTables (bool val=true)
void SetMode (MODE mode)
void SetNullExportMode (NULLCELLMODE mode)
void SetNullValue (double value, bool bHasValue=true)
void SetNumBands (int value, bool bHasValue=true)
void SetNumCols (UINT32 value)
void SetNumLins (UINT32 value)
void SetObjTypeSelected (RVC::OBJTYPE type)
void SetObjTypeSelected (OBJTYPEFLAG types)
void SetOverrideCRS (bool value)
void SetPyramidFlags (RVC::IMAGE::PYRAMID PyramidFlags)
void SetSaveProj (bool value=true)
void SetSeparateBands (bool value)
void SetTopologyType (RVC::VECTOR::TOPOLOGYTYPE type)
void SetUseNullValue (bool value)
void SetUserExtents (const DRECT3D &rect, bool bValid)
ERRVALUE SetValues (const XMLNODE *ParentNode)
void SetXShift (double val)
void SetYShift (double val)
void SetZUnits (int val)
ERRVALUE SMLValidateExportSettings (const RVC::OBJITEM &ObjItem)
ERRVALUE SMLValidateImportSettings ()
ERRVALUE WriteParmsIni () const

Protected Member Functions

virtual ERRVALUE v_GetSchema (XMLNODE *ParentNode) const
virtual ERRVALUE v_GetValues (XMLNODE *ParentNode) const
virtual ERRVALUE v_SetValues (const XMLNODE *ParentNode)

Static Protected Member Functions

static XMLNODEAddValueNode (XMLNODE *ParentNode, const char *name, const MISTRING &value)
static bool FindValueNode (const XMLNODE *ParentNode, const char *name, double &value)
static bool FindValueNode (const XMLNODE *ParentNode, const char *name, UINT32 &value)
static bool FindValueNode (const XMLNODE *ParentNode, const char *name, INT32 &value)
static bool FindValueNode (const XMLNODE *ParentNode, const char *name, bool &value)
static bool FindValueNode (const XMLNODE *ParentNode, const char *name, MISTRING &value)

Private Member Functions

ERRVALUE IniReadLow (SML::CLASSMEMBER *, const char *key)
ERRVALUE IniWriteLow (SML::CLASSMEMBER *, const char *key) const
virtual ERRVALUE v_AnalyzeFile (const FILEPATH &source)
virtual ERRVALUE v_AnalyzeObjects (const RVC::OBJITEMLIST &objects)
virtual ERRVALUE v_AnalyzeSource (const MISTRING &source)
virtual bool v_IsSafeToExport () const
virtual bool v_IsSafeToImport () const
virtual void v_OnChangeCRS ()
virtual ERRVALUE v_ReadParmsIni ()
virtual ERRVALUE v_SMLValidateExportSettings (const RVC::OBJITEM &ObjItem)
virtual ERRVALUE v_SMLValidateImportSettings ()
virtual ERRVALUE v_WriteParmsIni () const

Static Private Member Functions

static const XMLNODESETTINGS::FindChildValueNode (const XMLNODE *ParentNode, const char *name)

Private Attributes

bool m_bAssignLabelsToPolys
bool m_bByteOrderMSBFirst
bool m_bCanChangeMultiSingle
bool m_bCanDoMultiLink
bool m_bCanLink
bool m_bCreateElementIDTables
bool m_bCreateStdAttribTables
bool m_bDoContrast
bool m_bDoHistogram
bool m_bDoHypercube
bool m_bDoLink
bool m_bDoMultiLink
bool m_bDoOptimize
bool m_bDoSingleFile
bool m_bDoSurfaceProperties
bool m_bFlipHoriz
bool m_bFlipVert
bool m_bHadNonRandomAccessTables
bool m_bHasByteOrder
bool m_bHasCellSize
bool m_bHasCellType
bool m_bHasInitCol
bool m_bHasInitLin
bool m_bHasLastCol
bool m_bHasLastLin
bool m_bHasLinCol
bool m_bHasNullValue
bool m_bHasNumBands
bool m_bHasValidExtents
bool m_bInvertBW
bool m_bIs3D
bool m_bLinkTables
bool m_bOverrideCRS
bool m_bSaveProj
bool m_bSeperateBands
bool m_bUseNullValue
RVC::IMAGE::CELLTYPE m_CellType
RVC::IMAGE::CELLTYPE m_CellTypesAllowed
CHAR_ENCODING m_CharEncoding
double m_ColScale
int m_CompressionLevel
RVC::RASTER::COMPTYPE m_CompressionType
SPATREF::COORDREFSYS m_crs
SPATREF::COORDREFSYS m_ExtentsCRS
TRANS2D_MAPGEN m_ExtentsTMG
RVC::GEOMETRIC::ELEMSELECTPARMS::EXTRACT m_ExtractRegionTest
const FORMATm_format
GEOREFTYPE m_GeorefTypes
GEOREFTYPE m_GeorefTypeSelected
INT32 m_InitCol
INT32 m_InitLin
INT32 m_LastCol
INT32 m_LastLin
double m_LinScale
MODE m_mode
NULLCELLMODE m_NullMode
double m_NullValue
int m_NumBands
UINT32 m_NumCols
UINT32 m_NumLins
RVC::OBJTYPE m_objtype
OBJTYPEFLAG m_ObjTypeSelected
RVC::IMAGE::PYRAMID m_PyramidFlags
RVC::VECTOR::TOPOLOGYTYPE m_topologylevel
DRECT3D m_UserExtents
double m_xshift
double m_yshift
int m_zunits

Detailed Description

MIE::SETTINGS - all the parameters necessary to do an import or export.

Actual implementation can derive from this class to add additional parameters. If this is done, the FORMAT should override v_AllocSettings() to return the derived class.

There will only be one instance of this class for each import / export settings dialog, so the class should be considered to be the "defaults" to use for all files or objects selected. Information specific to each object or file should be stored in the appropriate MIE::JOB_BASE.


Member Enumeration Documentation

Enumerator:
NULLCELL_FromSource 
NULLCELL_Zero 
NULLCELL_Min 
NULLCELL_Max 
NULLCELL_UserDefined 

Constructor & Destructor Documentation

MIE::SETTINGS::SETTINGS ( const FORMAT format,
MODE  mode,
OBJTYPEFLAG  ObjType = OBJTYPEFLAG_ALL 
)
virtual MIE::SETTINGS::~SETTINGS (  )  [virtual]

Member Function Documentation

static XMLNODE* MIE::SETTINGS::AddValueNode ( XMLNODE ParentNode,
const char *  name,
const MISTRING value 
) [static, protected]

Add name/value "variable" as child node.

void MIE::SETTINGS::ClearLinColRange (  )  [inline]
static bool MIE::SETTINGS::FindValueNode ( const XMLNODE ParentNode,
const char *  name,
double &  value 
) [static, protected]

Find named child of "variable" node and parse value into double.

Returns:
true if value found, false if not
Parameters:
ParentNode Parent node
name Value name
value Value returned
static bool MIE::SETTINGS::FindValueNode ( const XMLNODE ParentNode,
const char *  name,
UINT32 value 
) [static, protected]

Find named child of "variable" node and parse value into UINT32.

Returns:
true if value found, false if not
Parameters:
ParentNode Parent node
name Value name
value Value returned
static bool MIE::SETTINGS::FindValueNode ( const XMLNODE ParentNode,
const char *  name,
INT32 value 
) [static, protected]

Find named child of "variable" node and parse value into INT32.

Returns:
true if value found, false if not
Parameters:
ParentNode Parent node
name Value name
value Value returned
static bool MIE::SETTINGS::FindValueNode ( const XMLNODE ParentNode,
const char *  name,
bool &  value 
) [static, protected]

Find named child of "variable" node and parse value into bool.

Returns:
true if value found, false if not
Parameters:
ParentNode Parent node
name Value name
value Value returned
static bool MIE::SETTINGS::FindValueNode ( const XMLNODE ParentNode,
const char *  name,
MISTRING value 
) [static, protected]

Find named child of "variable" node and parse value into MISTRING.

Returns:
true if value found, false if not
Parameters:
ParentNode Parent node
name Value name
value Value returned
bool MIE::SETTINGS::GetAssignLabelsToPolys (  )  const [inline]

Set if should attach labels to polygons.

bool MIE::SETTINGS::GetByteOrderMSBFirst (  )  const [inline]

Set if MSB first (raster only).

bool MIE::SETTINGS::GetCanChangeMultiSingle (  )  const [inline]

Determine if the option to export all selected objects to single file should be enabled or not.

SETTINGS just stores this flag. The method to determine if it should be set is in FORMAT

bool MIE::SETTINGS::GetCanDoMultiLink (  )  const [inline]
bool MIE::SETTINGS::GetCanLink (  )  const [inline]

Return whether or not the selectd file(s) can be linked (This is usually set by FORMAT::v_AnalyzeFile().

RVC::IMAGE::CELLTYPE MIE::SETTINGS::GetCellType (  )  const [inline]

Get currently selected cell type.

RVC::IMAGE::CELLTYPE MIE::SETTINGS::GetCellTypesAllowed (  )  const [inline]
CHAR_ENCODING MIE::SETTINGS::GetCharEncoding (  )  const [inline]
double MIE::SETTINGS::GetColScale (  )  const [inline]
int MIE::SETTINGS::GetCompressionLevel (  )  const [inline]
RVC::RASTER::COMPTYPE MIE::SETTINGS::GetCompressionType (  )  const [inline]

Compress rasters.

const SPATREF::COORDREFSYS& MIE::SETTINGS::GetCoordRefSys (  )  const [inline]

Get the CRS of the object coordinates.

bool MIE::SETTINGS::GetCreateElementIDTables (  )  const [inline]

Return true if the output object should have element ID tables (ignored if output object type isn't vector).

bool MIE::SETTINGS::GetCreateStdAttribTables (  )  const [inline]

Return true if the output object should have standard attributes.

bool MIE::SETTINGS::GetDoContrast (  )  const [inline]
bool MIE::SETTINGS::GetDoHistogram (  )  const [inline]
bool MIE::SETTINGS::GetDoHypercube (  )  const [inline]

Return true if the import should make a hypercube.

Note that the import module for the given format must support this feature for this to have any effect.

bool MIE::SETTINGS::GetDoLink (  )  const [inline]

Return true if the import should just link.

bool MIE::SETTINGS::GetDoMultiLink (  )  const [inline]

Return true if the import should make a multilink raster.

bool MIE::SETTINGS::GetDoOptimize (  )  const [inline]

Return true if the output vector should be optimized (ignored if output object type isn't vector).

bool MIE::SETTINGS::GetDoSingleFile (  )  const [inline]

Export all selected objects to single file.

bool MIE::SETTINGS::GetDoSurfaceProperties (  )  const [inline]

Calculate surface properties after import of raster.

const SPATREF::COORDREFSYS& MIE::SETTINGS::GetExtentsCoordRefSys (  )  const [inline]

Get the CRS of the extents.

const TRANS2D_MAPGEN& MIE::SETTINGS::GetExtentsTrans (  )  const [inline]

Return a TRANS2D_MAPGEN for translating from the extents CRS to the object CRS.

RVC::GEOMETRIC::ELEMSELECTPARMS::EXTRACT MIE::SETTINGS::GetExtractRegionTest (  )  const [inline]

Return type of test, REGIONTEST_CompInside or REGIONTEST_PartInside.

bool MIE::SETTINGS::GetFlipHorz (  )  const [inline]

Flip vertically (raster only).

bool MIE::SETTINGS::GetFlipVert (  )  const [inline]

Flip horizontally (raster only).

const FORMAT& MIE::SETTINGS::GetFormat (  )  const [inline]
GEOREFTYPE MIE::SETTINGS::GetGeorefTypes (  )  const [inline]

Georeference types available (detected) for import.

GEOREFTYPE MIE::SETTINGS::GetGeorefTypeSelected (  )  const [inline]

Georeference type to import/export.

INT32 MIE::SETTINGS::GetInitCol (  )  const [inline]
INT32 MIE::SETTINGS::GetInitLin (  )  const [inline]
bool MIE::SETTINGS::GetInvertBW (  )  const [inline]

Invert black/white (raster only).

INT32 MIE::SETTINGS::GetLastCol (  )  const [inline]
INT32 MIE::SETTINGS::GetLastLin (  )  const [inline]
bool MIE::SETTINGS::GetLinkTables (  )  const [inline]

Return true if the import should link table subobjects. Only applicable if the import is NOT linking to a geometric.

double MIE::SETTINGS::GetLinScale (  )  const [inline]
MODE MIE::SETTINGS::GetMode (  )  const [inline]
NULLCELLMODE MIE::SETTINGS::GetNullExportMode (  )  const [inline]
double MIE::SETTINGS::GetNullValue (  )  const [inline]
int MIE::SETTINGS::GetNumBands (  )  const [inline]

Number of raster bands.

UINT32 MIE::SETTINGS::GetNumCols (  )  const [inline]
UINT32 MIE::SETTINGS::GetNumLins (  )  const [inline]
RVC::OBJTYPE MIE::SETTINGS::GetObjType (  )  const

Get the selected destination object type (as RVC::OBJTYPE).

OBJTYPEFLAG MIE::SETTINGS::GetObjTypeFlag (  )  const

Get the selected destination object type (as OBJTYPEFLAG).

bool MIE::SETTINGS::GetOverrideCRS (  )  const [inline]

Get whether to override CRS in data or not.

RVC::IMAGE::PYRAMID MIE::SETTINGS::GetPyramidFlags (  )  const [inline]

Get pyramid flags to use for raster import.

bool MIE::SETTINGS::GetSaveProj (  )  const [inline]

On import, save projection prameters as an implied georeference object.

ERRVALUE MIE::SETTINGS::GetSchema ( XMLNODE ParentNode  )  const [inline]

Gets the XML Schema for this class (schema yet to be defined).

bool MIE::SETTINGS::GetSeparateBands (  )  const [inline]

Set if should import as "separate" rasters rather than composite.

RVC::VECTOR::TOPOLOGYTYPE MIE::SETTINGS::GetTopologyType (  )  const [inline]

Desired vector topology level (eg: RVC::VECTOR::TOPOLOGYTYPE_Polygonal).

bool MIE::SETTINGS::GetUseNullValue (  )  const [inline]

Set if null value is actually used (raster only).

const DRECT3D& MIE::SETTINGS::GetUserExtents (  )  const [inline]

Return the user-specified extents to extract.

ERRVALUE MIE::SETTINGS::GetValues ( XMLNODE ParentNode  )  const [inline]

Set values in an XML node based on SETTINGS.

There will be a child node for each value, such as...

   <settings>
      <DoSingleFile>true</DoSingleFile>
      <DoLink>false</DoLink>
      ...
   </settings>

The above assumes the XMLNODE passed in is <settings>

double MIE::SETTINGS::GetXShift (  )  const [inline]
double MIE::SETTINGS::GetYShift (  )  const [inline]
int MIE::SETTINGS::GetZUnits (  )  const [inline]

If not 0, Z coord will be converted from whatever this says to meters. If 0, z coord will be left alone.

bool MIE::SETTINGS::HasByteOrder (  )  const [inline]

raster byte order has been set

bool MIE::SETTINGS::HasCellSize (  )  const [inline]

raster cell size has been set

bool MIE::SETTINGS::HasCellType (  )  const [inline]

raster data type has been set

bool MIE::SETTINGS::HasCRS (  )  const [inline]
bool MIE::SETTINGS::HasInitCol (  )  const [inline]
bool MIE::SETTINGS::HasInitLin (  )  const [inline]
bool MIE::SETTINGS::HasLastCol (  )  const [inline]
bool MIE::SETTINGS::HasLastLin (  )  const [inline]
bool MIE::SETTINGS::HasLinCol (  )  const [inline]

raster NumLins and NumCols have been set

bool MIE::SETTINGS::HasNonRandomAccessTables (  )  const [inline]

See if the database has tables which are not randomly accessable (will be setup by derived v_AnalyzeFile).

bool MIE::SETTINGS::HasNullValue (  )  const [inline]

raster null value has been set

bool MIE::SETTINGS::HasNumBands (  )  const [inline]

raster NumBands has been set

bool MIE::SETTINGS::HasValidExtents (  )  const [inline]

Return true if the Extents has been set If set, vector and CAD import will extract (maybe others too).

ERRVALUE MIE::SETTINGS::IniReadLow ( SML::CLASSMEMBER ,
const char *  key 
) [private]
ERRVALUE MIE::SETTINGS::IniWriteLow ( SML::CLASSMEMBER ,
const char *  key 
) const [private]
bool MIE::SETTINGS::Is3D (  )  const [inline]

Return true if the data is 3D.

bool MIE::SETTINGS::IsSafeToExport (  )  const
bool MIE::SETTINGS::IsSafeToImport (  )  const
ERRVALUE MIE::SETTINGS::ReadParmsIni (  ) 

Read default parameters out of INI file.

void MIE::SETTINGS::SetAssignLabelsToPolys ( bool  AssignLabelsToPolys  )  [inline]

Set if should attach labels to polygons.

void MIE::SETTINGS::SetByteOrderMSBFirst ( bool  value,
bool  bHasValue = true 
) [inline]

Set if MSB first.

void MIE::SETTINGS::SetCanChangeMultiSingle ( bool  value = true  )  [inline]

Determine if the option to export all selected objects to single file should be enabled or not.

SETTINGS just stores this flag. The method to determine if it should be set is in FORMAT

void MIE::SETTINGS::SetCanDoMultiLink ( bool  value = true  )  [inline]
void MIE::SETTINGS::SetCanLink ( bool  value = true  )  [inline]

Set whether or not the selectd file(s) can be linked (This is usually set by FORMAT::v_AnalyzeFile().

void MIE::SETTINGS::SetCellSize ( double  linscale,
double  colscale,
bool  bHasValue = true 
) [inline]
void MIE::SETTINGS::SetCellType ( RVC::IMAGE::CELLTYPE  celltype,
bool  bHasValue = true 
) [inline]
void MIE::SETTINGS::SetCellTypesAllowed ( RVC::IMAGE::CELLTYPE  value  )  [inline]

Set which cell types are allowed.

void MIE::SETTINGS::SetCharEncoding ( CHAR_ENCODING  value  )  [inline]
void MIE::SETTINGS::SetCompressionLevel ( int  value  )  [inline]
void MIE::SETTINGS::SetCompressionType ( RVC::RASTER::COMPTYPE  type  )  [inline]

Compress rasters.

void MIE::SETTINGS::SetCoordRefSys ( const SPATREF::COORDREFSYS crs  ) 

Set the CRS of the object coordinates NOTE: This is for the crs specified by the user.

If, the v_Import determines that this is wrong, it should change it in the JOB_BASE, not the settings. Actually, FORMAT::v_AnalyzeFile() should have determined it before v_Import and set it correctly in the SETTINGS to begin with

void MIE::SETTINGS::SetCreateElementIDTables ( bool  val = true  )  [inline]

Set to true if the output object should have element ID tables (ignored if output object type isn't vector).

void MIE::SETTINGS::SetCreateStdAttribTables ( bool  val = true  )  [inline]

Set to true if the output object should have standard attributes.

void MIE::SETTINGS::SetDoContrast ( bool  val = false  )  [inline]

Set to true if export should use a contrast subobject if available.

void MIE::SETTINGS::SetDoHistogram ( bool  val = true  )  [inline]

Set to true if import should make a histogram if applicable.

void MIE::SETTINGS::SetDoHypercube ( bool  val = true  )  [inline]

Set if import should make hypercube if possible.

void MIE::SETTINGS::SetDoLink ( bool  val = true  )  [inline]

Set to true if the import should just link.

void MIE::SETTINGS::SetDoMultiLink ( bool  val = true  )  [inline]

Set to true if the import should create a multilink raster.

void MIE::SETTINGS::SetDoOptimize ( bool  val = true  )  [inline]

Set to true if the output vector should be optimized (ignored if output object type isn't vector).

void MIE::SETTINGS::SetDoSingleFile ( bool  val = true  )  [inline]

Export all selected objects to single file.

void MIE::SETTINGS::SetDoSurfaceProperties ( bool  DoSurface = true  )  [inline]

Calculate surface properties after import of raster.

void MIE::SETTINGS::SetExtentsCoordRefSys ( const SPATREF::COORDREFSYS crs  ) 

Set the CRS of the UserExtents.

void MIE::SETTINGS::SetExtractRegionTest ( RVC::GEOMETRIC::ELEMSELECTPARMS::EXTRACT  val  )  [inline]

set type of test, REGIONTEST_CompInside or REGIONTEST_PartInside

void MIE::SETTINGS::SetFlipHorz ( bool  value  )  [inline]

Flip raster vertically.

void MIE::SETTINGS::SetFlipVert ( bool  value  )  [inline]

Flip horizontally.

void MIE::SETTINGS::SetGeorefTypes ( GEOREFTYPE  types  )  [inline]

Georeference types available (detected).

void MIE::SETTINGS::SetGeorefTypeSelected ( GEOREFTYPE  type  )  [inline]

Georeference type to import/export.

void MIE::SETTINGS::SetHasLinCol ( bool  value = true  )  [inline]
void MIE::SETTINGS::SetHasNonRandomAccessTables ( bool  value = true  )  [inline]

Set that the database has tables which are not randomly accessable (will be setup by derived v_AnalyzeFile).

void MIE::SETTINGS::SetInitCol ( INT32  value,
bool  bHasValue = true 
) [inline]
void MIE::SETTINGS::SetInitLin ( INT32  value,
bool  bHasValue = true 
) [inline]
void MIE::SETTINGS::SetInvertBW ( bool  value  )  [inline]

Invert raster black/white.

void MIE::SETTINGS::SetIs3D ( bool  val  )  [inline]

set to true if the data is 3D

void MIE::SETTINGS::SetLastCol ( INT32  value,
bool  bHasValue = true 
) [inline]
void MIE::SETTINGS::SetLastLin ( INT32  value,
bool  bHasValue = true 
) [inline]
void MIE::SETTINGS::SetLinkTables ( bool  val = true  )  [inline]

Set to true if import should link table subobjects. Only applicable if NOT linking to a geometric format.

void MIE::SETTINGS::SetMode ( MODE  mode  )  [inline]
void MIE::SETTINGS::SetNullExportMode ( NULLCELLMODE  mode  ) 
void MIE::SETTINGS::SetNullValue ( double  value,
bool  bHasValue = true 
) [inline]
void MIE::SETTINGS::SetNumBands ( int  value,
bool  bHasValue = true 
) [inline]

Number of raster bands.

void MIE::SETTINGS::SetNumCols ( UINT32  value  )  [inline]
void MIE::SETTINGS::SetNumLins ( UINT32  value  )  [inline]
void MIE::SETTINGS::SetObjTypeSelected ( RVC::OBJTYPE  type  ) 
void MIE::SETTINGS::SetObjTypeSelected ( OBJTYPEFLAG  types  ) 
void MIE::SETTINGS::SetOverrideCRS ( bool  value  )  [inline]
void MIE::SETTINGS::SetPyramidFlags ( RVC::IMAGE::PYRAMID  PyramidFlags  )  [inline]
void MIE::SETTINGS::SetSaveProj ( bool  value = true  )  [inline]

On import, save projection prameters as an implied georeference object.

void MIE::SETTINGS::SetSeparateBands ( bool  value  )  [inline]
static const XMLNODE* MIE::SETTINGS::SETTINGS::FindChildValueNode ( const XMLNODE ParentNode,
const char *  name 
) [static, private]
void MIE::SETTINGS::SetTopologyType ( RVC::VECTOR::TOPOLOGYTYPE  type  )  [inline]

Desired vector topology level (eg: RVC::VECTOR::TOPOLOGYTYPE_Polygonal).

void MIE::SETTINGS::SetUseNullValue ( bool  value  )  [inline]

Set if null value is actually used.

void MIE::SETTINGS::SetUserExtents ( const DRECT3D rect,
bool  bValid 
)
ERRVALUE MIE::SETTINGS::SetValues ( const XMLNODE ParentNode  )  [inline]

Set values in the SETTINGS from an XML structure There should be a child node for each value, such as.

..

   <settings>
      <DoSingleFile>true</DoSingleFile>
      <DoLink>false</DoLink>
      ...
   </settings>

The above assumes the XMLNODE passed in is <settings>

void MIE::SETTINGS::SetXShift ( double  val  )  [inline]
void MIE::SETTINGS::SetYShift ( double  val  )  [inline]
void MIE::SETTINGS::SetZUnits ( int  val  )  [inline]
ERRVALUE MIE::SETTINGS::SMLValidateExportSettings ( const RVC::OBJITEM ObjItem  )  [inline]
Parameters:
ObjItem Object being exported
ERRVALUE MIE::SETTINGS::SMLValidateImportSettings (  )  [inline]

Validate the settings before exporting from SML.

See full description on v_SMLValidateExportSettings()

virtual ERRVALUE MIE::SETTINGS::v_AnalyzeFile ( const FILEPATH source  )  [private, virtual]

Analyze a file and determine initial import settings Note: this will be called by FORMAT::AnalyzeSource If you have no other reason to derive from SETTINGS than to implement this function, you can implement FORMAT::v_AnalyzeFile instead.

virtual ERRVALUE MIE::SETTINGS::v_AnalyzeObjects ( const RVC::OBJITEMLIST objects  )  [private, virtual]

Analyze objects to be exported.

If you have no other reason to derive from SETTINGS than to implement this function, you can implement FORMAT::v_AnalyzeObjects instead

virtual ERRVALUE MIE::SETTINGS::v_AnalyzeSource ( const MISTRING source  )  [private, virtual]

Analyze a file and determine initial import settings.

Unless you're an ODBC format, override v_AnalyzeFile instead Note: this will be called by FORMAT::AnalyzeSource If you have no other reason to derive from SETTINGS than to implement this function, you can implement FORMAT::v_AnalyzeSource instead

virtual ERRVALUE MIE::SETTINGS::v_GetSchema ( XMLNODE ParentNode  )  const [protected, virtual]

Append XML Schema nodes to a schema.

Derived class should call the base class version first to fill in the base class Schema, then should append its own parts XXX I may remove this. Don't know that it's actually necessary.

virtual ERRVALUE MIE::SETTINGS::v_GetValues ( XMLNODE ParentNode  )  const [protected, virtual]

Set values in an XML node based on SETTINGS.

Derived class should call the base class version first to fill in the base class values, then should append its own parts

virtual bool MIE::SETTINGS::v_IsSafeToExport (  )  const [private, virtual]

Determine if have sufficient parameters to proceed.

Will be called by UI_BASE::CheckOK()

virtual bool MIE::SETTINGS::v_IsSafeToImport (  )  const [private, virtual]

Determine if have sufficient parameters to proceed.

Will be called by UI_BASE::CheckOK()

virtual void MIE::SETTINGS::v_OnChangeCRS (  )  [inline, private, virtual]

For use by Legacy derived class so it can set its CRS.

virtual ERRVALUE MIE::SETTINGS::v_ReadParmsIni (  )  [private, virtual]

Called to read default parameters from Ini file Would reather have a method which takes an XMLNODE and sets parameters from that.

Would need another one to return an XMLNODE that lists all the parameters we COULD have and their types. This could be used to determine what INI things to read and also to build the SMLCLASS representation.

virtual ERRVALUE MIE::SETTINGS::v_SetValues ( const XMLNODE ParentNode  )  [protected, virtual]

Set values in the SETTINGS from an XML structure Derived class should call the base class version first to fill in the base class values, then should process its own parts.

virtual ERRVALUE MIE::SETTINGS::v_SMLValidateExportSettings ( const RVC::OBJITEM ObjItem  )  [private, virtual]

Validate the settings before exporting from SML.

Some of the legacy formats have this function pointer that needs to be called by SML before doing the actual import or export. The major thing this is used for is to allow the SML class representation to have table/field name members that can be set and this function does the actual lookup, verifies that they exist and then sets the members that would have been set via the GUI if that had been used. Note, this method will ONLY be called from the SML implementation.

Parameters:
ObjItem Object being exported
virtual ERRVALUE MIE::SETTINGS::v_SMLValidateImportSettings (  )  [private, virtual]

Validate the settings before exporting from SML.

See full description on v_SMLValidateExportSettings()

virtual ERRVALUE MIE::SETTINGS::v_WriteParmsIni (  )  const [private, virtual]

Called to write default parameters to Ini file Would reather have a method which returns an XMLNODE with all the parameters to save.

ERRVALUE MIE::SETTINGS::WriteParmsIni (  )  const

Write default parameters to INI file.


Member Data Documentation

Set if combobox for changing single/multi should be enabled.

bool MIE::SETTINGS::m_bCanLink [private]

Extents that user entered to filter imported elements with.

Link to external format

Keep Element ID tables.

Keep Standard Attribute Tables.

Use contrast subobject for export.

Make a histogram.

Create hypercube (if possible).

bool MIE::SETTINGS::m_bDoLink [private]

Link to external format.

Create multilink raster.

Optimize the vector.

Export all selected objects to single file.

Set if import filter extents (m_UserExtents) are valid, import processes need to set ouput side of TRANSPARM.

bool MIE::SETTINGS::m_bIs3D [private]

Set if data is 3D.

Link db table subobjects of geometric if geometric is a link.

double MIE::SETTINGS::m_ColScale [private]

Override CRS detected during import with CRS in settings.

Coordinate Reference System for external file.

Projection that extents are in.

User defined extents in map coords -> object coords.

Type of test, REGIONTEST_CompInside or REGIONTEST_PartInside.

const FORMAT& MIE::SETTINGS::m_format [private]

External georeference types available.

Georeference type to import/export.

double MIE::SETTINGS::m_LinScale [private]
double MIE::SETTINGS::m_NullValue [private]

Object type currently importing to (XXX RVC::OBJTYPE?).

selected object type MIE::OBJTYPEFLAG_..

Pyramid flags to use (bitwise ORed with pyramid type when importing raster).

Desired vector topology level (eg: RVC::VECTOR::TOPOLOGYTYPE_Polygonal).

double MIE::SETTINGS::m_xshift [private]
double MIE::SETTINGS::m_yshift [private]
int MIE::SETTINGS::m_zunits [private]

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

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