#include <MemoryOutputCallbacks.h>

Inheritance diagram for prt::MemoryOutputCallbacks:

Public Member Functions
virtual const uint8_t *	getBlock (size_t blockNum, size_t *outBlockSize) const =0

virtual prt::ContentType	getBlockContentType (size_t blockNum) const =0

virtual const wchar_t *	getBlockEncoderId (size_t blockNum) const =0

virtual const size_t *	getBlockInitialShapeIndices (size_t blockNum) const =0

virtual const wchar_t *	getBlockName (size_t blockNum) const =0

virtual size_t	getBlockNumInitialShapeIndices (size_t blockNum) const =0

virtual size_t	getNumBlocks () const =0

Public Member Functions inherited from prt::SimpleOutputCallbacks
virtual bool	canSeek () const =0

virtual Status	close (uint64_t handle, const size_t *isIndices, size_t isCount)=0

virtual Status	closeCGAError ()=0

virtual Status	closeCGAPrint ()=0

virtual Status	closeCGAReport ()=0

virtual Status	logStats (uint64_t handle, const size_t isIndices, size_t isCount, ContentType contentType, const prt::AttributeMap stats)

virtual uint64_t	open (const wchar_t encoderId, const ContentType contentType, const wchar_t name, StringEncoding enc=SE_NATIVE, OpenMode mode=OPENMODE_ALWAYS, prt::Status *stat=0)=0

virtual Status	openCGAError (const wchar_t *name)=0

virtual Status	openCGAPrint (const wchar_t *name)=0

virtual Status	openCGAReport (const wchar_t *name)=0

virtual Status	seek (uint64_t handle, int64_t offset, SeekOrigin origin)=0

virtual uint64_t	tell (uint64_t handle, Status *stat=0)=0

virtual Status	write (uint64_t handle, const wchar_t *string)=0

virtual Status	write (uint64_t handle, const uint8_t *buffer, size_t size)=0

Public Member Functions inherited from prt::Callbacks
virtual Status	assetError (size_t isIndex, CGAErrorLevel level, const wchar_t key, const wchar_t uri, const wchar_t *message)=0

virtual Status	attrBool (size_t isIndex, int32_t shapeID, const wchar_t *key, bool value)=0

virtual Status	attrBoolArray (size_t isIndex, int32_t shapeID, const wchar_t key, const bool ptr, size_t size, size_t nRows)=0

virtual Status	attrFloat (size_t isIndex, int32_t shapeID, const wchar_t *key, double value)=0

virtual Status	attrFloatArray (size_t isIndex, int32_t shapeID, const wchar_t key, const double ptr, size_t size, size_t nRows)=0

virtual Status	attrString (size_t isIndex, int32_t shapeID, const wchar_t key, const wchar_t value)=0

virtual Status	attrStringArray (size_t isIndex, int32_t shapeID, const wchar_t key, const wchar_t const *ptr, size_t size, size_t nRows)=0

virtual Status	cgaError (size_t isIndex, int32_t shapeID, CGAErrorLevel level, int32_t methodId, int32_t pc, const wchar_t *message)=0

virtual double	cgaGetCoord (size_t isIndex, CoordSelector sel, double x, double y, double z, Status *stat=0)

virtual Status	cgaPrint (size_t isIndex, int32_t shapeID, const wchar_t *txt)=0

virtual Status	cgaReportBool (size_t isIndex, int32_t shapeID, const wchar_t *key, bool value)=0

virtual Status	cgaReportFloat (size_t isIndex, int32_t shapeID, const wchar_t *key, double value)=0

virtual Status	cgaReportString (size_t isIndex, int32_t shapeID, const wchar_t key, const wchar_t value)=0

virtual Status	generateError (size_t isIndex, Status status, const wchar_t *message)=0

virtual Continuation	progress (float percentageCompleted)

Public Member Functions inherited from prt::Object
void	destroy () const

virtual char *	toXML (char result, size_t resultSize, Status *stat=0) const =0

char *	toXMLDocument (char result, size_t resultSize, Status *stat=0) const

Static Public Member Functions
static MemoryOutputCallbacks *	create (StringEncoding cgaOutputEnc=SE_NATIVE, const wchar_t generateErrorBlockName=nullptr, Status status=nullptr)

Additional Inherited Members
Public Types inherited from prt::SimpleOutputCallbacks
enum	OpenMode { OPENMODE_ALWAYS, OPENMODE_IF_NOT_EXISTING }

enum	SeekOrigin { SO_BEGIN, SO_CURRENT, SO_END }

enum	StringEncoding { SE_NATIVE, SE_UTF8, SE_UTF16 }

Public Types inherited from prt::Callbacks
enum	Continuation { CONTINUE, CANCEL_AND_FINISH, CANCEL_ASAP }

enum	CoordSelector { PROJ_X, PROJ_Y, WGS84_LAT, WGS84_LON, WGS84_ALT_METER, LAYER_X, LAYER_Y, LAYER_Z }

Protected Member Functions inherited from prt::Object
	Object (const Object &)

Detailed Description

Memory block-based implementation of the SimpleOutputCallbacks interface. After encoding (i.e. after the generate() call), the named blocks can be read by the client with a number of dedicated calls.

In order to free the blocks the MemoryOutputCallbacks instance has to be destroyed.

Member Function Documentation

◆ create()

static MemoryOutputCallbacks* prt::MemoryOutputCallbacks::create	(	StringEncoding	cgaOutputEnc = `SE_NATIVE`,
		const wchar_t *	generateErrorBlockName = `nullptr`,
		Status *	status = `nullptr`
	)

static

Creates a MemoryCallbacks instance. The returned instance must be destroyed by the caller.

Parameters

	cgaOutputEnc	Optional encoding for cgaPrint, cgaReport and cgaError (string) calls.
	generateErrorBlockName	Optional: Specifies the block name used to hold the contents of the generateError callback. If set to nullptr, no block will be created.
[out]	status	Optional pointer to return the status.

Returns: a pointer to the instance or nullptr in case of error.

◆ getBlock()

virtual const uint8_t* prt::MemoryOutputCallbacks::getBlock	(	size_t	blockNum,
		size_t *	outBlockSize
	)		const

pure virtual

See also: getNumBlocks

Parameters

	blockNum	Index of block to get.
[out]	outBlockSize	Pointer to return size of block in bytes.

Returns: Pointer to the block.

◆ getBlockContentType()

virtual prt::ContentType prt::MemoryOutputCallbacks::getBlockContentType ( size_t blockNum ) const

pure virtual

Parameters

blockNum Index of block.

Returns: ContentType of block.

◆ getBlockEncoderId()

virtual const wchar_t* prt::MemoryOutputCallbacks::getBlockEncoderId ( size_t blockNum ) const

pure virtual

Parameters

blockNum Index of block.

Returns: Encoder ID of block.

◆ getBlockInitialShapeIndices()

virtual const size_t* prt::MemoryOutputCallbacks::getBlockInitialShapeIndices ( size_t blockNum ) const

pure virtual

See also: getBlockNumInitialShapeIndices

Parameters

blockNum Index of block.

Returns: Pointer to array of initial shape indices.

◆ getBlockName()

virtual const wchar_t* prt::MemoryOutputCallbacks::getBlockName ( size_t blockNum ) const

pure virtual

Parameters

blockNum Index of block.

Returns: name of block.

◆ getBlockNumInitialShapeIndices()

virtual size_t prt::MemoryOutputCallbacks::getBlockNumInitialShapeIndices ( size_t blockNum ) const

pure virtual

See also: getBlockInitialShapeIndices

Parameters

blockNum Index of block.

Returns: Number of initial shape indices for block.

◆ getNumBlocks()

virtual size_t prt::MemoryOutputCallbacks::getNumBlocks ( ) const

pure virtual

See also: getBlock

Returns: number of allocated blocks.

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

MemoryOutputCallbacks.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ getBlock()

◆ getBlockContentType()

◆ getBlockEncoderId()

◆ getBlockInitialShapeIndices()

◆ getBlockName()

◆ getBlockNumInitialShapeIndices()

◆ getNumBlocks()