libCZI::IMetadataSegment Class Reference

Interface representing the metadata-segment. More...

#include <libCZI.h>

Public Types
enum	MemBlkType { XmlMetadata , Attachment }
	Values that represent the two different data types found in the metadata-segment. More...

Public Member Functions
virtual std::shared_ptr< const void >	GetRawData (MemBlkType type, size_t *ptrSize)=0
virtual void	DangerousGetRawData (MemBlkType type, const void *&ptr, size_t &size) const =0
std::shared_ptr< ICziMetadata >	CreateMetaFromMetadataSegment ()

Detailed Description

Interface representing the metadata-segment.

Member Enumeration Documentation

MemBlkType

enum libCZI::IMetadataSegment::MemBlkType

Values that represent the two different data types found in the metadata-segment.

Enumerator
XmlMetadata	The metadata (in UTF8-XML-format)
Attachment	The attachment (not currently used).

Member Function Documentation

CreateMetaFromMetadataSegment()

std::shared_ptr<ICziMetadata> libCZI::IMetadataSegment::CreateMetaFromMetadataSegment ( )

inline

Creates metadata object from this metadata segment.

Returns

The newly created metadata object.

DangerousGetRawData()

virtual void libCZI::IMetadataSegment::DangerousGetRawData ( MemBlkType  type, const void *&  ptr, size_t &  size  ) const

pure virtual

Get a pointer to the raw data. Note that the pointer returned is only valid during the lifetime of the sub-block-object.

Parameters

	type	The metadata-segment memory-block type.
[out]	ptr	The pointer to the data is stored here.
[out]	size	The size of the data.

GetRawData()

virtual std::shared_ptr<const void> libCZI::IMetadataSegment::GetRawData ( MemBlkType  type, size_t *  ptrSize  )

pure virtual

Gets raw data.

Parameters

	type	The metadata-segment memory-block type.
[out]	ptrSize	If non-null, thus size of the data (in bytes) is stored here.

Returns

The raw data.

---

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

• libCZI/libCZI.h