IlvS57Loader Class Reference

This class is used to get the list of features of the S57 files. More...

#include <ilviews/maps/format/s57/s57loader.h>

Inheritance diagram for IlvS57Loader:

List of all members.

Public Member Functions
	IlvS57Loader (IlvDisplay *display, const IlString &fileName)
	Initializes an S57 loader before it reads the S57 file.
	IlvS57Loader (IlvDisplay *display)
	Initializes an S57 loader.
virtual IlvMapLineString *	createMapLineString (IlvFRIDRecord *fr, IlvS57EnumerationArray &ori, IlvS57EnumerationArray &usags)
	Creates a map line string object from an S57 feature.
virtual IlvMapMultiPoint *	createMapMultiPoint (IlvFRIDRecord *fr, IlvS57EnumerationArray &ori, IlvS57EnumerationArray &usags)
	Creates a map multi point object from an S57 feature.
virtual IlvMapPolygon *	createMapPolygon (IlvFRIDRecord *fr, IlvS57EnumerationArray &ori, IlvS57EnumerationArray &usags)
	Creates a map polygon object from an S57 feature.
virtual IlvFeatureRenderer *	getDefaultFeatureRenderer (IlvDisplay *)
	Returns the default renderer for this feature iterator.
const char *	getFilename () const
	Returns the S57 file or the S57 catalog file.
virtual IlvMapsError	getInitStatus () const
	Checks the initialization status of this feature iterator.
virtual IlBoolean	getLowerRightCorner (IlvCoordinate &) const
	Returns the lower right corner of the rectangle containing all the map features of this iterator.
virtual const IlvMapFeature *	getNextFeature (IlvMapsError &error)
	Returns the next map feature from the list of S57 features.
const IlvProjection *	getProjection () const
	Returns the projection in which the geometric coordinates of the map features are expressed or 0 if the feature iterator returns ungeoreferenced map features.
virtual IlBoolean	getUpperLeftCorner (IlvCoordinate &) const
	Returns the upper left corner of the rectangle containing all the map features of this iterator.
void	readIt ()
	Reads the map features.
void	restart ()
	Sets position to the beginning of the map feature list.
void	setFilename (const char *filename)
	Sets the S57 file or the S57 catalog file.

---

Detailed Description

This class is used to get the list of features of the S57 files.

Library: ilvmaps

This class is used to get the list of map features from a set of S57 files.

See also:

IlvS57Reader, IlvS57Renderer

---

Constructor & Destructor Documentation

IlvS57Loader::IlvS57Loader

(

IlvDisplay *

display

)

Initializes an S57 loader.

Parameters:

display

The display.

IlvS57Loader::IlvS57Loader	(	IlvDisplay *	display,
		const IlString &	fileName
	)

Initializes an S57 loader before it reads the S57 file.

Parameters:

	display	The display.
	fileName	The file name or catalog file name to read.

---

Member Function Documentation

virtual IlvMapLineString* IlvS57Loader::createMapLineString	(	IlvFRIDRecord *	fr,
		IlvS57EnumerationArray &	ori,
		IlvS57EnumerationArray &	usags
	)			[virtual]

Creates a map line string object from an S57 feature.

Creates an IlvMapLineString object from an S57 feature.

Parameters:

	fr	The S57 feature.
	ori	The orientation of the S57 feature.
	usags	The usage indicator of the S57 feature.

Returns:

The created object.

virtual IlvMapMultiPoint* IlvS57Loader::createMapMultiPoint	(	IlvFRIDRecord *	fr,
		IlvS57EnumerationArray &	ori,
		IlvS57EnumerationArray &	usags
	)			[virtual]

Creates a map multi point object from an S57 feature.

Creates an IlvMapMultiPoint object from an S57 feature.

Parameters:

	fr	The S57 feature.
	ori	The orientation of the S57 feature.
	usags	The usage indicator of the S57 feature.

Returns:

The created object.

virtual IlvMapPolygon* IlvS57Loader::createMapPolygon	(	IlvFRIDRecord *	fr,
		IlvS57EnumerationArray &	ori,
		IlvS57EnumerationArray &	usags
	)			[virtual]

Creates a map polygon object from an S57 feature.

Creates an IlvMapPolygon object from an S57 feature.

Parameters:

	fr	The S57 feature.
	ori	The orientation of the S57 feature.
	usags	The usage indicator of the S57 feature.

Returns:

The created object.

virtual IlvFeatureRenderer* IlvS57Loader::getDefaultFeatureRenderer

(

IlvDisplay *

display

)

[virtual]

Returns the default renderer for this feature iterator.

Returns a renderer that can be used to translate the map features returned by this iterator into graphic objects. Feature iterators that store some rendering information in the attributes of the map features, such as color, text font, line thickness and so on, can return a specific renderer which is able to take these attributes into account during the rendering process.

Returns:

The default renderer for this feature iterator.

Implements IlvMapFeatureIterator.

const char* IlvS57Loader::getFilename

(

)

const

Returns the S57 file or the S57 catalog file.

Returns:

The S57 file.

virtual IlvMapsError IlvS57Loader::getInitStatus

(

)

const [virtual]

Checks the initialization status of this feature iterator.

Returns:

The error code that may have happened during the iterator initialization.

Implements IlvMapFeatureIterator.

virtual IlBoolean IlvS57Loader::getLowerRightCorner

(

IlvCoordinate &

result

)

const [virtual]

Returns the lower right corner of the rectangle containing all the map features of this iterator.

Returns:

IlFalse if lower right is unknown.

Implements IlvMapFeatureIterator.

virtual const IlvMapFeature* IlvS57Loader::getNextFeature

(

IlvMapsError &

error

)

[virtual]

Returns the next map feature from the list of S57 features.

Parameters:

error

Contains the error message if one occurs.

Returns:

The next map feature from the list of S57 features. If there is an error or no more features, returns 0. You must manage the deletion of the returned map feature.

Implements IlvMapFeatureIterator.

const IlvProjection* IlvS57Loader::getProjection

(

)

const [virtual]

Returns the projection in which the geometric coordinates of the map features are expressed or 0 if the feature iterator returns ungeoreferenced map features.

Returns:

The projection of the geometry.

Implements IlvMapFeatureIterator.

virtual IlBoolean IlvS57Loader::getUpperLeftCorner

(

IlvCoordinate &

result

)

const [virtual]

Returns the upper left corner of the rectangle containing all the map features of this iterator.

Returns:

IlFalse if upper left is unknown.

Implements IlvMapFeatureIterator.

void IlvS57Loader::readIt

(

)

Reads the map features.

This function reads the S57 features from the S57 file or the S57 catalog files. This function is called by the constructor with two parameters. If you have been used the constructor with one parameter, you need to call setFilename function beforehand.

void IlvS57Loader::setFilename

(

const char *

filename

)

Sets the S57 file or the S57 catalog file.

Sets the S57 file, this file can be a 57 catalog file which contains several S57 files. In the case of catalog, all its files will be read when the readIt function will be called.

Parameters:

filename

The file name.