Class CCziReaderWriterInfo

• Defined in File libCZI_ReadWrite.h

Inheritance Relationships

Base Type

• public libCZI::ICziReaderWriterInfo (Class ICziReaderWriterInfo)

Class Documentation

class CCziReaderWriterInfo : public libCZI::ICziReaderWriterInfo

An implementation of the ICziReaderWriterInfo-interface.

Public Functions

inline CCziReaderWriterInfo()

Default constructor - sets all information to “invalid” and sets fileGuid to GUID_NULL.

inline explicit CCziReaderWriterInfo(const GUID &fileGuid)

Constructor.

Parameters:

fileGuid – Unique identifier for the file.

inline virtual bool GetForceFileGuid() const override

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.

inline virtual const GUID &GetFileGuid() const override

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.

inline virtual libCZI::CZIFrameOfReference GetDefaultFrameOfReference() const override

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.

inline void SetForceFileGuid(bool forceFileGuid)

Sets “force file GUID” flag.

Parameters:

forceFileGuid – True to force the specified file-Guid.