imgdoc2::IDocInfo Class Reference

This interface is used for retrieving information about the document. More...

#include <IDocInfo.h>

Inheritance diagram for imgdoc2::IDocInfo:

Public Member Functions
virtual void	GetTileDimensions (imgdoc2::Dimension *dimensions, std::uint32_t &count)=0
virtual std::map< imgdoc2::Dimension, imgdoc2::Int32Interval >	GetMinMaxForTileDimension (const std::vector< imgdoc2::Dimension > &dimensions_to_query_for)=0
virtual std::uint64_t	GetTotalTileCount ()=0
virtual std::map< int, std::uint64_t >	GetTileCountPerLayer ()=0
std::vector< imgdoc2::Dimension >	GetTileDimensions ()
	IDocInfo (const IDocInfo &)=delete
IDocInfo &	operator= (const IDocInfo &)=delete
	IDocInfo (IDocInfo &&)=delete
IDocInfo &	operator= (IDocInfo &&)=delete

Detailed Description

This interface is used for retrieving information about the document.

Member Function Documentation

GetMinMaxForTileDimension()

virtual std::map< imgdoc2::Dimension, imgdoc2::Int32Interval > imgdoc2::IDocInfo::GetMinMaxForTileDimension ( const std::vector< imgdoc2::Dimension > &  dimensions_to_query_for )

pure virtual

Gets minimum and maximum value for specified tile dimension. If the minimum/maximum cannot be determined (for a dimension), then the result will be one where Minimum is greater than Maximum (=an invalid Int32Interval). This can happen e.g. if the document is empty, or the coordinates are Null.

Parameters

dimensions_to_query_for

Vector containing the dimensions to be queried for.

Returns

A map containing the min/max-information for the requested dimensions.

GetTileCountPerLayer()

virtual std::map< int, std::uint64_t > imgdoc2::IDocInfo::GetTileCountPerLayer ( )

pure virtual

Gets the total number of tiles (or bricks) per pyramid layer.

Returns

A map, where key is the pyramid layer number, and value is the total number of tiles (on this layer) in the document.

GetTileDimensions()

virtual void imgdoc2::IDocInfo::GetTileDimensions ( imgdoc2::Dimension *  dimensions, std::uint32_t &  count  )

pure virtual

Gets the tile dimensions used in the document.

Parameters

dimensions	If non-null, the dimensions are put into the array pointed to.
count	On input, the size of the array 'dimension' (number of elements). On output, the number of tile dimensions available.

GetTotalTileCount()

virtual std::uint64_t imgdoc2::IDocInfo::GetTotalTileCount ( )

pure virtual

Gets the total number of tiles (or bricks) in the document.

Returns

The total tile count.

---

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

• inc/IDocInfo.h