BVectorDataWriter Class Reference

#include <BVectorDataWriter.h>

Inheritance diagram for BVectorDataWriter:

Detailed Description

Abstract base class for objects that write vector data to a data sink.


Public Member Functions
virtual void	Close ()
	Closes the underlying data sink and frees resources.
virtual void	Open (const BString &dsName, const BParamList &parms)=0
	Opens the underlying data sink.
virtual	~BVectorDataWriter ()
	Destructor.
Protected Member Functions
virtual void	BeginWrite (void)
	Derived classes should override this method to perform initialization required at the beginning of the Write method.
	BVectorDataWriter (const BString &type, const BParamList &parms)
	Constructor.
	BVectorDataWriter ()
	Default constructor.
virtual void	CompleteDataSourceLayer (void)
	Completes processing for the current data source layer.
virtual void	CreateDataSourceLayer (const BVectorLayerPtr &pLayer)=0
	Creates a BLayer object appropriate for the underlying data source.
bool	CurFeatureIsVisible (void)
	Indicates whether or not the current feature is visible.
BMetadata &	GetCurFeatureMetadata (void)
	Gets the current BFeature's BMetadata.
virtual void	StoreAggregateAreaFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreAggregateGeoFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreAggregateLinearFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreAggregatePointFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreArcFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreBlockReferenceFeature (const BFeaturePtr &pFeature, const BVectorLayerPtr &pLayer)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreDonutFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreEllipseFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreExternalReferenceFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreLayer (const BLayerPtr &pLayer)
	Stores the contents of a BLayer in the data sink.
virtual void	StoreLineFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreMultilineTextFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreNoGeometryFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StorePathFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StorePixelBufferFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StorePointFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StorePolygonFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StorePolylineFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreRasterGridFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreRectangleFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreRoundRectangleFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreSymbolFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
virtual void	StoreTextFeature (const BFeaturePtr &pFeature)
	Writes the contents of the specified BFeature to the data sink.
Protected Attributes
BMetadata	m_curFeatureMetadata
	The BMetadata attached to the current BFeature.
bool	m_curFeatureVisible
	Indicates whether or not the current feature is marked "visible".
UInt32	m_featureNum
	The current BFeature number (used for progress reporting).
UInt32	m_totNumFeatures
	The total number of BFeatures to be written (used for progress reporting).

Constructor & Destructor Documentation

virtual ~BVectorDataWriter ( ) [virtual]

Destructor.

BVectorDataWriter ( ) [inline, protected]

Default constructor.

This constructor is hidden because this is an abstract class.

BVectorDataWriter	(	const BString &	type,
		const BParamList &	parms
	)			`[inline, protected]`

Constructor.

This constructor is hidden because this is an abstract class.

Parameters:

	type	The type of the underlying data sink.
	parms	A set of format-specific parameters that describe the nature of the writer that shall be created.

Member Function Documentation

virtual void BeginWrite ( void ) [protected, virtual]

Derived classes should override this method to perform initialization required at the beginning of the Write method.

Reimplemented from BDataWriter.

virtual void Close ( void ) [inline, virtual]

Closes the underlying data sink and frees resources.

Derived classes should call the base class implementation of this method.

Reimplemented from BDataWriter.

virtual void CompleteDataSourceLayer ( void ) [inline, protected, virtual]

Completes processing for the current data source layer.

Override to provide format-specific processing. Default implementation does nothing.

virtual void CreateDataSourceLayer ( const BVectorLayerPtr & pLayer ) [protected, pure virtual]

Creates a BLayer object appropriate for the underlying data source.

This is an abstract method that must be implemented in derived classes.

Parameters:

pLayer

the BVectorLayer that should be set up for the specific data format.

bool CurFeatureIsVisible ( void ) [inline, protected]

Indicates whether or not the current feature is visible.

Returns:: True if the current feature is visible, false otherwise

BMetadata& GetCurFeatureMetadata ( void ) [inline, protected]

Gets the current BFeature's BMetadata.

Returns:: The current BFeature's metadata

virtual void Open	(	const BString &	dsName,
		const BParamList &	parms
	)			`[pure virtual]`

Opens the underlying data sink.

Parameters:

	dsName	The name of the underlying data sink. For a file-based data sink, this would be the path and file name.
	parms	Format-specific parameters that describe how to open the data sink.

Implements BDataWriter.

virtual void StoreAggregateAreaFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BAggregateArea geometry object.

virtual void StoreAggregateGeoFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BAggregateGeo geometry object.

virtual void StoreAggregateLinearFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BAggregateLinear geometry object.

virtual void StoreAggregatePointFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BAggregatePoint geometry object.

virtual void StoreArcFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BArc geometry object.

virtual void StoreBlockReferenceFeature	(	const BFeaturePtr &	pFeature,
		const BVectorLayerPtr &	pLayer
	)			`[protected, virtual]`

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this feature type.

Parameters:

	pFeature	A BBlockRefFeature to write to the data sink.
	pLayer	The BVectorLayer that contains the BBlockDef.

virtual void StoreDonutFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BDonut geometry object.

virtual void StoreEllipseFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BEllipse geometry object.

virtual void StoreExternalReferenceFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this feature type.

Parameters:

pFeature

A BExternalRefFeature to write to the data sink.

virtual void StoreFeature ( const BFeaturePtr & pFeature ) [protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Parameters:

pFeature

The BFeature to write.

virtual void StoreLayer ( const BLayerPtr & pLayer ) [protected, virtual]

Stores the contents of a BLayer in the data sink.

Parameters:

pLayer

Pointer to the BLayer to be stored.

Implements BDataWriter.

virtual void StoreLineFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BLine geometry object.

virtual void StoreMultilineTextFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this feature type.

Parameters:

pFeature

A BMultilineTextFeature to write to the data sink.

virtual void StoreNoGeometryFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this feature type.

Parameters:

pFeature

A BFeature to write to the data sink.

virtual void StorePathFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BPath geometry object.

virtual void StorePixelBufferFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BPixelBuffer geometry object.

virtual void StorePointFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BPointGeo geometry object.

virtual void StorePolygonFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BPolygon geometry object.

virtual void StorePolylineFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BPolyline geometry object.

virtual void StoreRasterGridFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BRasterGrid geometry object.

virtual void StoreRectangleFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BRectangle geometry object.

virtual void StoreRoundRectangleFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this geometry.

Parameters:

pFeature

The BFeature containing a BRoundRectangle geometry object.

virtual void StoreSymbolFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this feature type.

Parameters:

pFeature

A BSymbolFeature to write to the data sink.

virtual void StoreTextFeature ( const BFeaturePtr & pFeature ) [inline, protected, virtual]

Writes the contents of the specified BFeature to the data sink.

Implement this in your derived class if the data type supports this feature type.

Parameters:

pFeature

A BTextFeature to write to the data sink.

Member Data Documentation

BMetadata m_curFeatureMetadata [protected]

The BMetadata attached to the current BFeature.

bool m_curFeatureVisible [protected]

Indicates whether or not the current feature is marked "visible".

UInt32 m_featureNum [protected]

The current BFeature number (used for progress reporting).

UInt32 m_totNumFeatures [protected]

The total number of BFeatures to be written (used for progress reporting).

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

BVectorDataWriter.h

GeoTranslate 5.0 From Blue Marble Geographics

BVectorDataWriter Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation