Class ICziMetadata

• Defined in File libCZI_Metadata.h

Inheritance Relationships

Base Type

• public libCZI::IXmlNodeRead (Class IXmlNodeRead)

Class Documentation

class ICziMetadata : public libCZI::IXmlNodeRead

Representation of the CZI-metadata.

Public Functions

virtual bool IsXmlValid() const = 0

Query if the CZI’s metadata (the XML) is well-formed and parsed correctly. If this is not the case, then other methods (of this interface) will throw a LibCZIXmlParseException exception.

Returns:

True if the XML is well-formed, false if not.

virtual std::string GetXml() = 0

Gets the metadata as an unprocessed UTF8-encoded XML-string.

Returns:

The metadata (unprocessed UTF8-encoded XML).

virtual std::shared_ptr<libCZI::ICziMultiDimensionDocumentInfo> GetDocumentInfo() = 0

Gets the “document information” part of the metadata.

Returns:

The “document information”.

virtual ~ICziMetadata() = default