Class ICziReaderWriterInfo

• Defined in File libCZI_ReadWrite.h

Inheritance Relationships

Derived Type

• public libCZI::CCziReaderWriterInfo (Class CCziReaderWriterInfo)

Class Documentation

class ICziReaderWriterInfo

Options for the CziReaderWriter.

Subclassed by libCZI::CCziReaderWriterInfo

Public Functions

virtual bool GetForceFileGuid() const = 0

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.

virtual const GUID &GetFileGuid() const = 0

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.

virtual libCZI::CZIFrameOfReference GetDefaultFrameOfReference() const = 0

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.

virtual ~ICziReaderWriterInfo() = default