libCZI::ICziWriterInfo Class Reference

The options for the CZI-writer. More...

#include <libCZI_Write.h>

Inheritance diagram for libCZI::ICziWriterInfo:

Public Member Functions
virtual const IDimBounds *	GetDimBounds () const =0
virtual const GUID &	GetFileGuid () const =0
virtual bool	TryGetMIndexMinMax (int *min, int *max) const =0
virtual bool	TryGetReservedSizeForAttachmentDirectory (size_t *size) const =0
virtual bool	TryGetReservedSizeForSubBlockDirectory (size_t *size) const =0
virtual bool	TryGetReservedSizeForMetadataSegment (size_t *size) const =0

Detailed Description

The options for the CZI-writer.

Member Function Documentation

GetDimBounds()

virtual const IDimBounds * libCZI::ICziWriterInfo::GetDimBounds ( ) const

pure virtual

Gets bounds for the subblocks we are going to add to the CZI. If this is a valid bounds, then the coordinates of each subblock added are checked against this bounds. In case of a violation, an LibCZIWriteException-exception is thrown.

Returns

Null if the bounds is not specified, else the bounds for the subblock's coordinates we want to add.

Implemented in libCZI::CCziWriterInfo.

GetFileGuid()

virtual const GUID & libCZI::ICziWriterInfo::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.

Returns

The file's unique identifier.

Implemented in libCZI::CCziWriterInfo.

TryGetMIndexMinMax()

virtual bool libCZI::ICziWriterInfo::TryGetMIndexMinMax ( int *  min, int *  max  ) const

pure virtual

Attempts to get the minimum and the maximum (inclusive) for the m-index. If returning a valid interval (ie. if the return value is true), then the M-coordinate of each subblock added is checked against this. Furthermore, in this case we require that all subblocks have a valid M-index.

Parameters

[out]	min	If non-null will receive the minimum M-index (inclusive).
[out]	max	If non-null will receive the maximum M-index (inclusive).

Returns

True if it succeeds, false the is no bounds for the M-index.

Implemented in libCZI::CCziWriterInfo.

TryGetReservedSizeForAttachmentDirectory()

virtual bool libCZI::ICziWriterInfo::TryGetReservedSizeForAttachmentDirectory ( size_t *  size ) const

pure virtual

Query whether to reserve space for the attachment-directory-segment at the start of the file. If returning true, the value returned for size has the following meaning: if it is >0, it is interpreted as the number of attachment-entries (ie. how many attachments can be put into the CZI). If it is 0 (and returning true), some default is used. If returning false, no space is reserved, and the attachment-directory is put at the end of the CZI. If the reserved space is not sufficient, then the attachment-directory-segment is put at the end of the CZI (and the reserved space is unused).

Parameters

[out]

size

If returning true, then this gives the number of attachment-entries to reserve.

Returns

True if space for the attachment-directory-segment is to be reserved, false otherwise.

Implemented in libCZI::CCziWriterInfo.

TryGetReservedSizeForMetadataSegment()

virtual bool libCZI::ICziWriterInfo::TryGetReservedSizeForMetadataSegment ( size_t *  size ) const

pure virtual

Query whether to reserve space for the metadata-segment at the start of the file. If returning true, the value returned for size has the following meaning: if it is >0, it is interpreted as the number of bytes available for the metadata-segment. If it is 0 (and returning true), some default is used. If returning false, no space is reserved, and the metadata-segment is put at the end of the CZI. If the reserved space is not sufficient, then the metadata-segment is put at the end of the CZI (and the reserved space is unused).

Parameters

[out]

size

If returning true, then this gives the number of bytes to be reserved in the metadata-segment.

Returns

True if space (in bytes) for the metadata is to be reserved, false otherwise.

Implemented in libCZI::CCziWriterInfo.

TryGetReservedSizeForSubBlockDirectory()

virtual bool libCZI::ICziWriterInfo::TryGetReservedSizeForSubBlockDirectory ( size_t *  size ) const

pure virtual

Query whether to reserve space for the subblock-directory-segment at the start of the file. If returning true, the value returned for size has the following meaning: if it is >0, it is interpreted as the number of subblock-entries (ie. how many subblocks can be put into the CZI). If it is 0 (and returning true), some default is used. If returning false, no space is reserved, and the subblock-directory is put at the end of the CZI. If the reserved space is not sufficient, then the subblock-directory-segment is put at the end of the CZI (and the reserved space is unused).

Parameters

[out]

size

If returning true, then this gives the number of subblock-entries to reserve.

Returns

True if space for the subblock-directory-segment is to be reserved, false otherwise.

Implemented in libCZI::CCziWriterInfo.

---

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

• libCZI/libCZI_Write.h