bioformats  5.1.8
Namespaces | Classes | Functions
ome::xml Namespace Reference

OME-XML Data Model. More...

Namespaces

 meta
 Metadata storage and retrieval.
 
 model
 Model objects.
 

Classes

class  OMEEntityResolver
 Entity resolver for the OME schemas. More...
 

Functions

ome::common::xml::dom::Document createDocument (const boost::filesystem::path &file, const ome::common::xml::dom::ParseParameters &params=ome::common::xml::dom::ParseParameters())
 Construct a Document from the content of a file. More...
 
ome::common::xml::dom::Document createDocument (const std::string &text, const ome::common::xml::dom::ParseParameters &params=ome::common::xml::dom::ParseParameters(), const std::string &id="membuf")
 Construct a Document from the content of a string. More...
 
ome::common::xml::dom::Document createDocument (std::istream &stream, const ome::common::xml::dom::ParseParameters &params=ome::common::xml::dom::ParseParameters(), const std::string &id="streambuf")
 Construct a Document from the content of an input stream. More...
 

Detailed Description

OME-XML Data Model.

Function Documentation

ome::common::xml::dom::Document ome::xml::createDocument ( const boost::filesystem::path &  file,
const ome::common::xml::dom::ParseParameters params = ome::common::xml::dom::ParseParameters() 
)

Construct a Document from the content of a file.

This is the same as ome::common::xml::dom::createDocument(const boost::filesystem::path&, EntityResolver&, const ParseParameters&) but uses OMEEntityResolver to resolve all OME schemas from the local catalog.

Parameters
filethe file to read.
paramsXML parser parameters.
Returns
the new Document.

References ome::common::xml::dom::createDocument().

Referenced by ome::xml::model::XMLAnnotation::asXMLElementInternal(), ome::bioformats::createOMEXMLMetadata(), ome::bioformats::getModulo(), ome::bioformats::getOriginalMetadata(), and ome::bioformats::validateXML().

+ Here is the caller graph for this function:

ome::common::xml::dom::Document ome::xml::createDocument ( const std::string &  text,
const ome::common::xml::dom::ParseParameters params = ome::common::xml::dom::ParseParameters(),
const std::string &  id = "membuf" 
)

Construct a Document from the content of a string.

This is the same as ome::common::xml::dom::createDocument(const std::string&, EntityResolver&, const ParseParameters&, const std::string&) but uses OMEEntityResolver to resolve all OME schemas from the local catalog.

Parameters
textthe string to use.
paramsXML parser parameters.
iddocument filename (for error reporting only).
Returns
the new Document.

References ome::common::xml::dom::createDocument().

ome::common::xml::dom::Document ome::xml::createDocument ( std::istream &  stream,
const ome::common::xml::dom::ParseParameters params = ome::common::xml::dom::ParseParameters(),
const std::string &  id = "streambuf" 
)

Construct a Document from the content of an input stream.

This is the same as ome::common::xml::dom::createDocument(std::istream&, EntityResolver&, const ParseParameters&, const std::string&) but uses OMEEntityResolver to resolve all OME schemas from the local catalog.

Parameters
streamthe stream to read.
paramsXML parser parameters.
iddocument filename (for error reporting only).
Returns
the new Document.

References ome::common::xml::dom::createDocument().