ome-xml
5.6.0
|
#include <ome/xml/model/Well.h>
Classes | |
class | Impl |
Private implementation details of Well model object. More... | |
Public Member Functions | |
Well () | |
Default constructor. | |
Well (const Well ©) | |
Copy constructor. More... | |
virtual | ~Well () |
Destructor. | |
const std::string & | elementName () const |
Get the element name of this model object. More... | |
bool | validElementName (const std::string &name) const |
Check if a given element name is valid for processing by this model object. More... | |
virtual SKIP void | update (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Update the object hierarchy recursively from an XML DOM tree. More... | |
bool | link (std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object) |
Link a given OME model object to this model object. More... | |
std::shared_ptr< std::string > | getExternalIdentifier () |
Get the ExternalIdentifier property. More... | |
const std::shared_ptr< std::string > | getExternalIdentifier () const |
Get the ExternalIdentifier property. More... | |
void | setExternalIdentifier (std::shared_ptr< std::string > &externalIdentifier) |
Set the ExternalIdentifier property. More... | |
const ome::xml::model::primitives::NonNegativeInteger & | getColumn () const |
Get the Column property. More... | |
void | setColumn (const ome::xml::model::primitives::NonNegativeInteger &column) |
Set the Column property. More... | |
std::shared_ptr< std::string > | getExternalDescription () |
Get the ExternalDescription property. More... | |
const std::shared_ptr< std::string > | getExternalDescription () const |
Get the ExternalDescription property. More... | |
void | setExternalDescription (std::shared_ptr< std::string > &externalDescription) |
Set the ExternalDescription property. More... | |
std::shared_ptr< ome::xml::model::primitives::Color > | getColor () |
Get the Color property. More... | |
const std::shared_ptr< ome::xml::model::primitives::Color > | getColor () const |
Get the Color property. More... | |
void | setColor (std::shared_ptr< ome::xml::model::primitives::Color > &color) |
Set the Color property. More... | |
std::shared_ptr< std::string > | getType () |
Get the Type property. More... | |
const std::shared_ptr< std::string > | getType () const |
Get the Type property. More... | |
void | setType (std::shared_ptr< std::string > &type) |
Set the Type property. More... | |
const std::string & | getID () const |
Get the ID property. More... | |
void | setID (const std::string &id) |
Set the ID property. More... | |
const ome::xml::model::primitives::NonNegativeInteger & | getRow () const |
Get the Row property. More... | |
void | setRow (const ome::xml::model::primitives::NonNegativeInteger &row) |
Set the Row property. More... | |
std::vector< std::shared_ptr< ome::xml::model::WellSample > >::size_type | sizeOfWellSampleList () const |
Get size of linked WellSample list. More... | |
std::vector< std::shared_ptr< ome::xml::model::WellSample > > & | getWellSampleList () |
Get the WellSample list. More... | |
const std::vector< std::shared_ptr< ome::xml::model::WellSample > > & | getWellSampleList () const |
Get the WellSample list. More... | |
std::shared_ptr< ome::xml::model::WellSample > & | getWellSample (std::vector< std::shared_ptr< ome::xml::model::WellSample >>::size_type index) |
Get WellSample. More... | |
const std::shared_ptr< ome::xml::model::WellSample > & | getWellSample (std::vector< std::shared_ptr< ome::xml::model::WellSample >>::size_type index) const |
Get WellSample. More... | |
void | setWellSample (std::vector< std::shared_ptr< ome::xml::model::WellSample >>::size_type index, std::shared_ptr< ome::xml::model::WellSample > &wellSample) |
Set WellSample. More... | |
void | addWellSample (std::shared_ptr< ome::xml::model::WellSample > &wellSample) |
Add WellSample. More... | |
void | removeWellSample (std::shared_ptr< ome::xml::model::WellSample > &wellSample) |
Remove WellSample. More... | |
std::weak_ptr< ome::xml::model::Reagent > | getLinkedReagent () |
Get linked Reagent. More... | |
const std::weak_ptr< ome::xml::model::Reagent > | getLinkedReagent () const |
Get linked Reagent. More... | |
void | linkReagent (std::shared_ptr< ome::xml::model::Reagent > &reagent) |
Link Reagent. More... | |
void | unlinkReagent (std::shared_ptr< ome::xml::model::Reagent > &reagent) |
Unlink Reagent. More... | |
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type | sizeOfLinkedAnnotationList () const |
Get size of linked Annotation list. More... | |
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type | getLinkedAnnotationList () const |
Get the linked Annotation list. More... | |
const std::weak_ptr< ome::xml::model::Annotation > & | getLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const |
Get linked Annotation. More... | |
const std::weak_ptr< ome::xml::model::Annotation > & | setLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Annotation > &annotation) |
Set linked Annotation. More... | |
bool | linkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation) |
Link Annotation. More... | |
bool | unlinkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation) |
Unlink Annotation. More... | |
std::weak_ptr< ome::xml::model::Plate > | getPlate () |
Get the Plate property. More... | |
const std::weak_ptr< ome::xml::model::Plate > | getPlate () const |
Get the Plate property. More... | |
void | setPlate (std::weak_ptr< ome::xml::model::Plate > &plate_BackReference) |
Set the Plate property. More... | |
const std::string & | getXMLNamespace () const |
Get the XML namespace for this model object. More... | |
Public Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
virtual | ~OMEModelObject () |
Destructor. | |
virtual common::xml::dom::Element | asXMLElement (common::xml::dom::Document &document) const |
Transform the object hierarchy rooted at this element to XML. More... | |
virtual void | asXMLElement (common::xml::dom::Document &document, common::xml::dom::Element &element) const |
Transform the object hierarchy rooted at this element to XML. More... | |
virtual void | update (const common::xml::dom::Element &element, ::ome::xml::model::OMEModel &model) |
Update the object hierarchy recursively from an XML DOM tree. More... | |
virtual bool | link (std::shared_ptr< Reference > &reference, std::shared_ptr<::ome::xml::model::OMEModelObject > &object) |
Link a given OME model object to this model object. More... | |
Public Member Functions inherited from ome::xml::model::OMEModelObject | |
virtual bool | link (std::shared_ptr< Reference > &reference, std::shared_ptr< OMEModelObject > &object)=0 |
Link a given OME model object to this model object. More... | |
Static Public Member Functions | |
static std::shared_ptr< Well > | create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Create a Well model object from DOM element. More... | |
Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
static std::vector< common::xml::dom::Element > | getChildrenByTagName (const common::xml::dom::Element &parent, const std::string &name) |
Retrieve all the children of an element that have a given tag name. More... | |
static std::string | stripNamespacePrefix (const std::string &value) |
Strip the namespace prefix from a tag name. More... | |
Protected Member Functions | |
virtual void | asXMLElementInternal (common::xml::dom::Document &document, common::xml::dom::Element &element) const |
Transform the object hierarchy rooted at this element to XML. More... | |
Protected Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
OMEModelObject (const std::string &objectType="OMEModelObject") | |
Constructor. More... | |
OMEModelObject (const OMEModelObject ©) | |
Copy constructor. More... | |
template<class C , typename T > | |
bool | contains (const C &container, const std::shared_ptr< T > &element) |
Check if a container contains a particular element. More... | |
Protected Member Functions inherited from ome::xml::model::OMEModelObject | |
OMEModelObject () | |
Constructor. | |
Private Attributes | |
std::shared_ptr< Impl > | impl |
Private implementation details. | |
Additional Inherited Members | |
Protected Attributes inherited from ome::xml::model::detail::OMEModelObject | |
ome::common::Logger | logger |
Message logger. | |
Well model object.
void ome::xml::model::Well::addWellSample | ( | std::shared_ptr< ome::xml::model::WellSample > & | wellSample | ) |
Add WellSample.
wellSample | the WellSample to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
|
protectedvirtual |
Transform the object hierarchy rooted at this element to XML.
This internal implementation of asXMLelement also requires an XML element, which must not be null, or may be instantiated and passed from superclasses.
Concrete model object implementations should override this method.
document | XML document for element creation. |
element | XML element for setting model data. |
Implements ome::xml::model::detail::OMEModelObject.
References ome::common::xml::dom::Node::appendChild(), ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), impl, and ome::common::xml::dom::Element::setAttribute().
|
static |
Create a Well model object from DOM element.
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. |
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. |
Referenced by ome::xml::model::Plate::update().
|
virtual |
Get the element name of this model object.
This will be the most-derived class name.
Implements ome::xml::model::OMEModelObject.
std::shared_ptr< ome::xml::model::primitives::Color > ome::xml::model::Well::getColor | ( | ) |
const std::shared_ptr< ome::xml::model::primitives::Color > ome::xml::model::Well::getColor | ( | ) | const |
const ome::xml::model::primitives::NonNegativeInteger & ome::xml::model::Well::getColumn | ( | ) | const |
std::shared_ptr< std::string > ome::xml::model::Well::getExternalDescription | ( | ) |
const std::shared_ptr< std::string > ome::xml::model::Well::getExternalDescription | ( | ) | const |
std::shared_ptr< std::string > ome::xml::model::Well::getExternalIdentifier | ( | ) |
const std::shared_ptr< std::string > ome::xml::model::Well::getExternalIdentifier | ( | ) | const |
const std::string & ome::xml::model::Well::getID | ( | ) | const |
const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Well::getLinkedAnnotation | ( | OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type | index | ) | const |
Get linked Annotation.
index | the index number of the Annotation. |
std::out_of_range | if the index is invalid. |
References impl.
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type ome::xml::model::Well::getLinkedAnnotationList | ( | ) | const |
std::weak_ptr< ome::xml::model::Reagent > ome::xml::model::Well::getLinkedReagent | ( | ) |
const std::weak_ptr< ome::xml::model::Reagent > ome::xml::model::Well::getLinkedReagent | ( | ) | const |
std::weak_ptr< ome::xml::model::Plate > ome::xml::model::Well::getPlate | ( | ) |
const std::weak_ptr< ome::xml::model::Plate > ome::xml::model::Well::getPlate | ( | ) | const |
const ome::xml::model::primitives::NonNegativeInteger & ome::xml::model::Well::getRow | ( | ) | const |
std::shared_ptr< std::string > ome::xml::model::Well::getType | ( | ) |
const std::shared_ptr< std::string > ome::xml::model::Well::getType | ( | ) | const |
std::shared_ptr< ome::xml::model::WellSample > & ome::xml::model::Well::getWellSample | ( | std::vector< std::shared_ptr< ome::xml::model::WellSample >>::size_type | index | ) |
Get WellSample.
index | the index number of the WellSample. |
std::out_of_range | if the index is invalid. |
References impl.
const std::shared_ptr< ome::xml::model::WellSample > & ome::xml::model::Well::getWellSample | ( | std::vector< std::shared_ptr< ome::xml::model::WellSample >>::size_type | index | ) | const |
Get WellSample.
index | the index number of the WellSample. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< std::shared_ptr< ome::xml::model::WellSample > > & ome::xml::model::Well::getWellSampleList | ( | ) |
const std::vector< std::shared_ptr< ome::xml::model::WellSample > > & ome::xml::model::Well::getWellSampleList | ( | ) | const |
|
virtual |
Get the XML namespace for this model object.
Implements ome::xml::model::OMEModelObject.
Referenced by asXMLElementInternal().
bool ome::xml::model::Well::link | ( | std::shared_ptr< Reference > & | reference, |
std::shared_ptr< ome::xml::model::OMEModelObject > & | object | ||
) |
Link a given OME model object to this model object.
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. |
true
if this model object was able to handle the reference, otherwise false
.References impl, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::Reagent::linkWell(), ome::xml::model::Annotation::linkWell(), and ome::xml::model::detail::OMEModelObject::logger.
bool ome::xml::model::Well::linkAnnotation | ( | const std::shared_ptr< ome::xml::model::Annotation > & | annotation | ) |
Link Annotation.
annotation | the Annotation to link. |
true
if the object was added to the internal annotationLinks list, otherwise false
.References impl.
void ome::xml::model::Well::linkReagent | ( | std::shared_ptr< ome::xml::model::Reagent > & | reagent | ) |
void ome::xml::model::Well::removeWellSample | ( | std::shared_ptr< ome::xml::model::WellSample > & | wellSample | ) |
Remove WellSample.
wellSample | the WellSample to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::Well::setColor | ( | std::shared_ptr< ome::xml::model::primitives::Color > & | color | ) |
void ome::xml::model::Well::setColumn | ( | const ome::xml::model::primitives::NonNegativeInteger & | column | ) |
void ome::xml::model::Well::setExternalDescription | ( | std::shared_ptr< std::string > & | externalDescription | ) |
void ome::xml::model::Well::setExternalIdentifier | ( | std::shared_ptr< std::string > & | externalIdentifier | ) |
void ome::xml::model::Well::setID | ( | const std::string & | id | ) |
const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Well::setLinkedAnnotation | ( | OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type | index, |
const std::shared_ptr< ome::xml::model::Annotation > & | annotation | ||
) |
Set linked Annotation.
index | the index number of the Annotation. |
annotation | the Annotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::Well::setPlate | ( | std::weak_ptr< ome::xml::model::Plate > & | plate_BackReference | ) |
void ome::xml::model::Well::setRow | ( | const ome::xml::model::primitives::NonNegativeInteger & | row | ) |
void ome::xml::model::Well::setType | ( | std::shared_ptr< std::string > & | type | ) |
void ome::xml::model::Well::setWellSample | ( | std::vector< std::shared_ptr< ome::xml::model::WellSample >>::size_type | index, |
std::shared_ptr< ome::xml::model::WellSample > & | wellSample | ||
) |
Set WellSample.
index | the index number of the WellSample. |
wellSample | the WellSample to set. |
std::out_of_range | if the index is invalid. |
References impl.
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type ome::xml::model::Well::sizeOfLinkedAnnotationList | ( | ) | const |
std::vector< std::shared_ptr< ome::xml::model::WellSample > >::size_type ome::xml::model::Well::sizeOfWellSampleList | ( | ) | const |
bool ome::xml::model::Well::unlinkAnnotation | ( | const std::shared_ptr< ome::xml::model::Annotation > & | annotation | ) |
Unlink Annotation.
annotation | the Annotation to unlink. |
true
if the Annotation was unlinked, otherwise false
if the Annotation was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::Well::unlinkReagent | ( | std::shared_ptr< ome::xml::model::Reagent > & | reagent | ) |
|
virtual |
Update the object hierarchy recursively from an XML DOM tree.
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. |
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::xml::model::OMEModel::addModelObject(), ome::xml::model::OMEModel::addReference(), addWellSample(), ome::xml::model::WellSample::create(), ome::common::xml::dom::Element::getAttribute(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), getID(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setColor(), setColumn(), setExternalDescription(), setExternalIdentifier(), setID(), setRow(), setType(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().
|
virtual |
Check if a given element name is valid for processing by this model object.
Used for processing nodes when interitance is involved.
name | the element name to check. |
true
if valid, false
if invalid. Implements ome::xml::model::detail::OMEModelObject.
Referenced by update().