uk.me.parabola.imgfmt.app.trergn
Class TREFileReader

java.lang.Object
  extended by uk.me.parabola.imgfmt.app.ImgReader
      extended by uk.me.parabola.imgfmt.app.trergn.TREFileReader
All Implemented Interfaces:
java.io.Closeable, Configurable

public class TREFileReader
extends ImgReader

This is the file that contains the overview of the map. There can be different zoom levels and each level of zoom has an associated set of subdivided areas. Each of these areas then points into the RGN file. The main focus of mkgmap is creating files, there are plenty of applications that read and display the data, reading is implemented only to the extent required to support creating the various auxiliary files etc.

Author:
Steve Ratcliffe

Constructor Summary
TREFileReader(ImgChannel chan)
           
 
Method Summary
 void config(EnhancedProperties props)
          Used to mark that a reader needs to be configured by command line properties.
 Area getBounds()
           
 java.lang.String[] getCopyrights()
           
 Subdivision[] subdivForLevel(int level)
          Return the subdivisions for the given level.
 
Methods inherited from class uk.me.parabola.imgfmt.app.ImgReader
close, getHeader, getReader, position, position, setHeader, setReader
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TREFileReader

public TREFileReader(ImgChannel chan)
Method Detail

getBounds

public Area getBounds()

subdivForLevel

public Subdivision[] subdivForLevel(int level)
Return the subdivisions for the given level.

Parameters:
level - The level, 0 being the most detailed. There may not be a level zero in the map.
Returns:
The subdivisions for the level. Never returns null; a zero length array is returned if there is no such level.

config

public void config(EnhancedProperties props)
Description copied from interface: Configurable
Used to mark that a reader needs to be configured by command line properties. The MapReader will be given the command line properties that were set before it is asked to load the map.

Parameters:
props - The input properties.

getCopyrights

public java.lang.String[] getCopyrights()