UUID model object.
More...
#include <ome/xml/model/UUID.h>
|
ome::compat::shared_ptr< Impl > | impl |
| Private implementation details.
|
|
§ UUID()
ome::xml::model::UUID::UUID |
( |
const UUID & |
copy | ) |
|
Copy constructor.
- Parameters
-
§ asXMLElement()
§ asXMLElementInternal()
§ create()
Create a UUID model object from DOM element.
- Parameters
-
element | root of the XML DOM tree to from which to construct the model object graph. |
model | handler for the OME model used to track instances and references seen during the update. |
- Exceptions
-
EnumerationException | if there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing. |
- Returns
- a new model object.
Referenced by ome::xml::model::TiffData::update().
§ elementName()
const std::string & ome::xml::model::UUID::elementName |
( |
| ) |
const |
|
virtual |
§ getFileName() [1/2]
ome::compat::shared_ptr< std::string > ome::xml::model::UUID::getFileName |
( |
| ) |
|
Get the FileName property.
- Returns
- the FileName property.
References impl.
§ getFileName() [2/2]
const ome::compat::shared_ptr< std::string > ome::xml::model::UUID::getFileName |
( |
| ) |
const |
Get the FileName property.
- Returns
- the FileName property.
References impl.
§ getValue()
const std::string & ome::xml::model::UUID::getValue |
( |
| ) |
const |
Get element value.
- Returns
- the std::string value.
References impl.
§ getXMLNamespace()
const std::string & ome::xml::model::UUID::getXMLNamespace |
( |
| ) |
const |
|
virtual |
§ link()
Link a given OME model object to this model object.
- Parameters
-
reference | type qualifier for the reference. This should be the corresponding reference type for object. If, for example, object is of type Image, reference must be of type ImageRef. |
object | Model object to link to. |
- Returns
true
if this model object was able to handle the reference, otherwise false
.
- Todo:
- the use of reference to provide type information for the type of object is unconventional and quite possibly unnecessary–a simple string or type_info would suffice for what it's being used for, if it's needed at all. Is this true for all cases? The implementation also needs to do strict checking of the object type; it's not currently failing if it's of the wrong type. This applies to all generated model objects implementing this interface.
References ome::xml::model::detail::OMEModelObject::link(), and ome::xml::model::detail::OMEModelObject::logger.
§ setFileName()
void ome::xml::model::UUID::setFileName |
( |
ome::compat::shared_ptr< std::string > & |
fileName | ) |
|
Set the FileName property.
- Parameters
-
fileName | the value to set. |
References impl.
Referenced by update().
§ setValue()
void ome::xml::model::UUID::setValue |
( |
const std::string & |
value | ) |
|
Set element value.
- Parameters
-
value | the std::string value. |
References impl.
§ update()
Update the object hierarchy recursively from an XML DOM tree.
- Note
- No properties are removed, only added or updated.
- Parameters
-
element | root of the XML DOM tree to from which to construct the model object graph. |
model | handler for the OME model used to track instances and references seen during the update. |
- Exceptions
-
EnumerationException | if there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing. |
Implements ome::xml::model::OMEModelObject.
References ome::common::xml::dom::Element::getAttribute(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::getTextContent(), ome::common::xml::dom::Element::hasAttribute(), impl, ome::xml::model::detail::OMEModelObject::logger, setFileName(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().
§ validElementName()
bool ome::xml::model::UUID::validElementName |
( |
const std::string & |
name | ) |
const |
|
virtual |
The documentation for this class was generated from the following files:
- ome/xml/model/UUID.h
- ome/xml/model/UUID.cpp