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

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

public class TREFile
extends ImgFile
implements Configurable

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. This is quite a complex file as there are quite a few miscellaneous pieces of information stored.

Author:
Steve Ratcliffe

Constructor Summary
TREFile(ImgChannel chan)
           
 
Method Summary
 void addCopyright(Label cr)
           
 void addInfo(java.lang.String msg)
          Add a string to the 'mapinfo' section.
 void addPointOverview(PointOverview ov)
           
 void addPolygonOverview(PolygonOverview ov)
           
 void addPolylineOverview(PolylineOverview ov)
           
 void config(EnhancedProperties props)
          Used to mark that a reader needs to be configured by command line properties.
 Zoom createZoom(int zoom, int bits)
           
 void setBounds(Area area)
           
 void setLastRgnPos(int lastRgnPos)
           
 void setMapId(int mapid)
           
 void setPoiDisplayFlags(byte b)
           
 void write(boolean includeExtendedTypeData)
           
 void writePost()
           
 
Methods inherited from class uk.me.parabola.imgfmt.app.ImgFile
close, getHeader, getReader, getSize, getWriter, isWritable, position, position, setHeader, setReader, setWriter, sync
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TREFile

public TREFile(ImgChannel chan)
Method Detail

createZoom

public Zoom createZoom(int zoom,
                       int bits)

addInfo

public void addInfo(java.lang.String msg)
Add a string to the 'mapinfo' section. This is a section between the header and the start of the data. Nothing points to it directly.

Parameters:
msg - A string, usually used to describe the program that generated the file.

addCopyright

public void addCopyright(Label cr)

addPointOverview

public void addPointOverview(PointOverview ov)

addPolylineOverview

public void addPolylineOverview(PolylineOverview ov)

addPolygonOverview

public void addPolygonOverview(PolygonOverview ov)

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.

Specified by:
config in interface Configurable
Parameters:
props - The input properties.

setLastRgnPos

public void setLastRgnPos(int lastRgnPos)

write

public void write(boolean includeExtendedTypeData)

writePost

public void writePost()

setMapId

public void setMapId(int mapid)

setBounds

public void setBounds(Area area)

setPoiDisplayFlags

public void setPoiDisplayFlags(byte b)