GridHeader Class Reference

A grid header object is used to hold the information contained in a grid's header More...

Collaboration diagram for GridHeader:
Collaboration graph

Public Member Functions

void CopyFrom (GridHeader pVal)
 Copies the contents of another instance of the grid header. More...
 
string get_ErrorMsg (int ErrorCode)
 Retrieves the error message associated with the specified error code. More...
 
void set_Owner (ref int t, ref int d, ref int s, ref int l, ref int __p5)
 For inner use only. More...
 

Properties

string ColorTable [get, set]
 Gets or sets a text string with information about color table. This value doesn't affect grid processing. More...
 
double dX [get, set]
 Gets or sets the width of the grid cell in physical units for the grid represented by the grid header More...
 
double dY [get, set]
 Gets or sets the height of a cell in the grid represented by the grid header. More...
 
GeoProjection GeoProjection [get, set]
 Not implemented. Get or sets the geoprojection associated with grid header. More...
 
ICallback GlobalCallback [get, set]
 The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications. More...
 
string Key [get, set]
 The key may be used by the programmer to store any string data associated with the object. More...
 
int LastErrorCode [get]
 Retrieves the last error generated in the object. More...
 
object NodataValue [get, set]
 The value representing cells in the grid with no-data or missing data values. More...
 
string Notes [get, set]
 Gets or sets notes or any additional information about the grid stored in the grid header. More...
 
int NumberCols [get, set]
 Gets or sets the number of columns for the grid represented by the grid header. More...
 
int NumberRows [get, set]
 Gets or sets the number of rows in the grid represented by the grid header. More...
 
string Projection [get, set]
 Gets or sets information about the projection of the grid represented by the grid header. Setting this value has no effect on the actual grid data. The projection should be expressed as a PROJ4 string. More...
 
double XllCenter [get, set]
 The x coordinate of the center of the lower-left cell in the grid represented by the grid header. More...
 
double YllCenter [get, set]
 Gets or sets the y coordinate of the center of the lower-left cell in the grid represented by the grid header. More...
 

Detailed Description

A grid header object is used to hold the information contained in a grid's header

Member Function Documentation

◆ CopyFrom()

void GridHeader.CopyFrom ( GridHeader  pVal)

Copies the contents of another instance of the grid header.

Parameters
pValThe grid header to copy setting from.

◆ get_ErrorMsg()

string GridHeader.get_ErrorMsg ( int  ErrorCode)

Retrieves the error message associated with the specified error code.

Parameters
ErrorCodeThe error code for which the error message is required.
Returns
The error message description for the specified error code.

◆ set_Owner()

void GridHeader.set_Owner ( ref int  t,
ref int  d,
ref int  s,
ref int  l,
ref int  __p5 
)

For inner use only.

Property Documentation

◆ ColorTable

string GridHeader.ColorTable
getset

Gets or sets a text string with information about color table. This value doesn't affect grid processing.

◆ dX

double GridHeader.dX
getset

Gets or sets the width of the grid cell in physical units for the grid represented by the grid header

◆ dY

double GridHeader.dY
getset

Gets or sets the height of a cell in the grid represented by the grid header.

◆ GeoProjection

GeoProjection GridHeader.GeoProjection
getset

Not implemented. Get or sets the geoprojection associated with grid header.

◆ GlobalCallback

ICallback GridHeader.GlobalCallback
getset

The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications.

Deprecated:
v4.9.3 Use GlobalSettings.ApplicationCallback instead.

◆ Key

string GridHeader.Key
getset

The key may be used by the programmer to store any string data associated with the object.

◆ LastErrorCode

int GridHeader.LastErrorCode
get

Retrieves the last error generated in the object.

◆ NodataValue

object GridHeader.NodataValue
getset

The value representing cells in the grid with no-data or missing data values.

◆ Notes

string GridHeader.Notes
getset

Gets or sets notes or any additional information about the grid stored in the grid header.

◆ NumberCols

int GridHeader.NumberCols
getset

Gets or sets the number of columns for the grid represented by the grid header.

◆ NumberRows

int GridHeader.NumberRows
getset

Gets or sets the number of rows in the grid represented by the grid header.

◆ Projection

string GridHeader.Projection
getset

Gets or sets information about the projection of the grid represented by the grid header. Setting this value has no effect on the actual grid data. The projection should be expressed as a PROJ4 string.

◆ XllCenter

double GridHeader.XllCenter
getset

The x coordinate of the center of the lower-left cell in the grid represented by the grid header.

◆ YllCenter

double GridHeader.YllCenter
getset

Gets or sets the y coordinate of the center of the lower-left cell in the grid represented by the grid header.