libCZI::ICziMetadata Class Referenceabstract
Representation of the CZI-metadata. More...
#include <libCZI_Metadata.h>
Inheritance diagram for libCZI::ICziMetadata:
Public Member Functions | |
| virtual bool | IsXmlValid () const =0 |
| virtual std::string | GetXml ()=0 |
| virtual std::shared_ptr< libCZI::ICziMultiDimensionDocumentInfo > | GetDocumentInfo ()=0 |
 Public Member Functions inherited from libCZI::IXmlNodeRead | |
| virtual std::wstring | Name () const =0 |
| virtual bool | TryGetAttribute (const wchar_t *attributeName, std::wstring *attribValue) const =0 |
| virtual void | EnumAttributes (const std::function< bool(const std::wstring &attribName, const std::wstring &attribValue)> &enumFunc) const =0 |
| virtual bool | TryGetValue (std::wstring *value) const =0 |
| virtual std::shared_ptr< IXmlNodeRead > | GetChildNodeReadonly (const char *path)=0 |
| virtual void | EnumChildren (const std::function< bool(std::shared_ptr< IXmlNodeRead >)> &enumChildren)=0 |
| bool | TryGetValueAsDouble (double *p) |
| bool | TryGetValueAsFloat (float *p) |
| bool | TryGetValueAsInt32 (std::int32_t *p) |
| bool | TryGetValueAsUInt32 (std::uint32_t *p) |
| bool | TryGetValueAsInt64 (std::int64_t *p) |
| bool | TryGetValueAsUInt64 (std::uint64_t *p) |
| bool | TryGetValueAsBool (bool *p) |
Detailed Description
Representation of the CZI-metadata.
Member Function Documentation
◆ GetDocumentInfo()
|
pure virtual |
Gets the "document information" part of the metadata.
- Returns
- The "document information".
◆ GetXml()
|
pure virtual |
Gets the metadata as an unprocessed UTF8-encoded XML-string.
- Returns
- The metadata (unprocessed UTF8-encoded XML).
◆ IsXmlValid()
|
pure virtual |
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 thrown a LibCZIXmlParseException exception.
- Returns
- True if the XML is well-formed, false if not.
The documentation for this class was generated from the following file:
- libCZI/libCZI_Metadata.h
