prt::FileOutputCallbacks Class Reference

#include <FileOutputCallbacks.h>

Inheritance diagram for prt::FileOutputCallbacks:

Static Public Member Functions
static FileOutputCallbacks *	create (const wchar_t *dir, StringEncoding cgaOutputEnc=SE_NATIVE, const wchar_t *generateErrorFileName=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 }
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
Protected Member Functions inherited from prt::Object
	Object (const Object &)

Detailed Description

File-based implementation of the SimpleOutputCallbacks interface.

Member Function Documentation

create()

static FileOutputCallbacks* prt::FileOutputCallbacks::create ( const wchar_t *  dir, StringEncoding  cgaOutputEnc = SE_NATIVE, const wchar_t *  generateErrorFileName = nullptr, Status *  status = nullptr  )

static

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

Parameters

	dir	Absolute filesystem path to the base directory. The name parameter of the open calls will be a file relative to this directory.
	cgaOutputEnc	Optional encoding for cgaPrint, cgaReport and cgaError (string) calls.
	generateErrorFileName	Optional: Specifies the file name used to write out the content of the generateError callback. May contain a relative path to dir. If set to nullptr, no file will be written.
[out]	stat	Optional pointer to return the status.

Returns

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

---

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

• FileOutputCallbacks.h