TSLS57DataClient Class Reference

Inheritance diagram for TSLS57DataClient:

Detailed Description

This interface class defines the callbacks that are issued by the S63SDK for both media ingest and display of S57 data.

For media ingest, the following callbacks are used: attachmentForCell cellCancelled coordinateSystemForCell currentCellVersion currentTime loadCellIntermediaryData loadCellTMFData notifyError notifyWarning populateEntityInformation progress storeIngestedCell

For display the following callbacks are used: cellsInExtent currentTime dataStoreExtent loadCellTMFData notifyError notifyWarning

Public Member Functions
virtual bool	cellsInExtent (const TSLGeodeticExtent &extent, const char **&cellNames, const char **&dataServerIDs, int &numberOfCells)=0
virtual const TSLGeodeticExtent &	dataStoreExtent ()=0
virtual TSLS63DataClientType	type ()
virtual	~TSLS57DataClient ()=0
Public Member Functions inherited from TSLS63DataClient
virtual void	attachmentForCell (const char *filename, const char *cellName, const char *dataServerID, TSLSimpleString &attachmentID, TSLSimpleString &attachmentLookup)=0
virtual bool	cellCancelled (const char *cellName, const char *dataServerID, const char **replacementCells, int numberOfReplacementCells)=0
virtual const TSLCoordinateSystem *	coordinateSystemForCell (const char *cellName, const char *dataServerID)=0
virtual int	currentCellVersion (const char *cellName, const char *dataServerID)=0
virtual TSLTimeType	currentTime ()=0
virtual TSLS63CellLoadResultEnum	loadCellIntermediaryData (const char *cellName, const char *dataServerID, TSLS63EncryptedData *intermediaryData)=0
virtual TSLS63CellLoadResultEnum	loadCellTMFData (const char *cellName, const char *dataServer, TSLS63EncryptedData *tmfData)=0
virtual bool	locateCatalogueForCell (const char *cellName, const char *dataServerID, int exchangeSetNumber, TSLSimpleString &locationOfCatalogue)=0
virtual void	notifyError (TSLS63ErrorCodeEnum s63ErrorCode, const char *cellName, const char *dataServerID, const char *additionalInformation=NULL)=0
virtual void	notifyWarning (const char *additionalInformation, const char *cellName=NULL, const char *dataServerID=NULL)=0
virtual void	populateEntityInformation (TSLEntity *entity, TSLEntitySet *entitySet, const char *cellName, const char *dataServerID)=0
virtual bool	progress (double percentOfExchangeSetDone, double percentOfCurrentCellDone)=0
virtual void	storeIngestedCell (const TSLS63EncryptedData *cellTMF, const TSLS63EncryptedData *cellIntermediaryData, const char *cellName, const char *dataServerID, const TSLGeodeticExtent &cellExtent, int cellEdition, int cellUpdateNumber)=0
virtual void	ingestedCellInformation (const TSLS63CellInformation &cellInformation)
virtual	~TSLS63DataClient ()=0

Constructor & Destructor Documentation

~TSLS57DataClient()

TSLS57DataClient::~TSLS57DataClient ( )

inlinepure virtual

Member Function Documentation

cellsInExtent()

virtual bool TSLS57DataClient::cellsInExtent ( const TSLGeodeticExtent & extent, const char **& cellNames, const char **& dataServerIDs, int & numberOfCells )

pure virtual

This callback will be invoked when drawing the S57 dataset. This callback should return an array of cell names and their respective data server IDs which fall inside the provided extent. This will indicate to the data layer the cells which should be drawn, provided they fall into the current scale band.

Returning true will indicate that cells do fall in the extent. Returning false will indicate the cells do not fall within the provided extent.

Parameters

extent	The extent which the cells should fall in.
cellNames	An array of cell names which fall inside the extent parameter. This variable should be populated by the callback.
dataServerIDs	An equivalent data server IDs of the cells which fall inside the extent parameter. This variable should be populated by the callback.
numberOfCells	The number of cells which fall inside the extent.

dataStoreExtent()

virtual const TSLGeodeticExtent & TSLS57DataClient::dataStoreExtent ( )

pure virtual

This callback will be invoked during display of S57 data.

The implementation of this method should return the full extent of all the cells in the current S57 data store.

type()

TSLS63DataClientType TSLS57DataClient::type ( )

inlinevirtual

Returns the type of data client which has been instantiated.

Reimplemented from TSLS63DataClient.