libCZI::ICziReaderWriterInfo Class Reference

Options for the CziReaderWriter. More...

#include <libCZI_ReadWrite.h>

Inheritance diagram for libCZI::ICziReaderWriterInfo:

Public Member Functions
virtual bool	GetForceFileGuid () const =0
virtual const GUID &	GetFileGuid () const =0
virtual libCZI::CZIFrameOfReference	GetDefaultFrameOfReference () const =0

Detailed Description

Options for the CziReaderWriter.

Member Function Documentation

GetDefaultFrameOfReference()

virtual libCZI::CZIFrameOfReference libCZI::ICziReaderWriterInfo::GetDefaultFrameOfReference ( ) const

pure virtual

Gets the default frame-of-reference which is to be used by the reader-writer-object. This determines which frame-of-reference is used when the enum value "CZIFrameOfReference::Default" is used with an operation of the reader-writer-object. If the value specified here is "CZIFrameOfReference::Invalid" or "CZIFrameOfReference::Default", then "CZIFrameOfReference::RawSubBlockCoordinateSystem" will be used.

Returns

The default frame of reference.

Implemented in libCZI::CCziReaderWriterInfo.

GetFileGuid()

virtual const GUID & libCZI::ICziReaderWriterInfo::GetFileGuid ( ) const

pure virtual

Gets file's unique identifier. If we report GUID_NULL, then the file-writer will create a GUID on its own. Note that this GUID is only retrieved and used if the existing file is empty or if GetForceFileGuid() gives true.

Returns

The file's unique identifier.

Implemented in libCZI::CCziReaderWriterInfo.

GetForceFileGuid()

virtual bool libCZI::ICziReaderWriterInfo::GetForceFileGuid ( ) const

pure virtual

Gets a value indicating that the GUID in the existing file-handler should be replaced with the GUID reported by 'GetFileGuid()'.

Returns

True if the GUID should be replaced, false otherwise.

Implemented in libCZI::CCziReaderWriterInfo.

---

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

• libCZI/libCZI_ReadWrite.h