libCZI::CCziReaderWriterInfo Class Reference

An implementation of the ICziReaderWriterInfo-interface. More...

#include <libCZI_ReadWrite.h>

Inheritance diagram for libCZI::CCziReaderWriterInfo:

Public Member Functions
	CCziReaderWriterInfo ()
	Default constructor - sets all information to "invalid" and sets fileGuid to GUID_NULL.
	CCziReaderWriterInfo (const GUID &fileGuid)
bool	GetForceFileGuid () const override
const GUID &	GetFileGuid () const override
libCZI::CZIFrameOfReference	GetDefaultFrameOfReference () const override
void	SetForceFileGuid (bool forceFileGuid)

Detailed Description

An implementation of the ICziReaderWriterInfo-interface.

Constructor & Destructor Documentation

CCziReaderWriterInfo()

libCZI::CCziReaderWriterInfo::CCziReaderWriterInfo ( const GUID &  fileGuid )

inlineexplicit

Constructor.

Parameters

fileGuid

Unique identifier for the file.

Member Function Documentation

GetDefaultFrameOfReference()

libCZI::CZIFrameOfReference libCZI::CCziReaderWriterInfo::GetDefaultFrameOfReference ( ) const

inlineoverridevirtual

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.

Implements libCZI::ICziReaderWriterInfo.

GetFileGuid()

const GUID & libCZI::CCziReaderWriterInfo::GetFileGuid ( ) const

inlineoverridevirtual

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.

Implements libCZI::ICziReaderWriterInfo.

GetForceFileGuid()

bool libCZI::CCziReaderWriterInfo::GetForceFileGuid ( ) const

inlineoverridevirtual

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.

Implements libCZI::ICziReaderWriterInfo.

SetForceFileGuid()

void libCZI::CCziReaderWriterInfo::SetForceFileGuid ( bool  forceFileGuid )

inline

Sets "force file GUID" flag.

Parameters

forceFileGuid

True to force the specified file-Guid.

---

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

• libCZI/libCZI_ReadWrite.h