46 #ifndef OME_XML_MODEL_PLANE_H 47 #define OME_XML_MODEL_PLANE_H 57 #include <ome/common/xml/dom/Document.h> 58 #include <ome/common/xml/dom/Element.h> 59 #include <ome/common/xml/dom/Node.h> 60 #include <ome/common/xml/dom/NodeList.h> 62 #include <ome/xml/model/primitives/Quantity.h> 64 #include <ome/xml/model/Pixels.h> 65 #include <ome/xml/model/detail/OMEModelObject.h> 66 #include <ome/xml/model/enums/UnitsLength.h> 67 #include <ome/xml/model/enums/UnitsTime.h> 68 #include <ome/xml/model/primitives/NonNegativeInteger.h> 89 ome::compat::shared_ptr<Impl>
impl;
120 static ome::compat::shared_ptr< Plane>
150 link (ome::compat::shared_ptr<Reference>& reference,
151 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
158 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
166 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
182 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
190 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
206 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
214 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
230 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
238 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
254 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
262 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
326 ome::compat::shared_ptr<std::string>
334 const ome::compat::shared_ptr<std::string>
343 setHashSHA1 (ome::compat::shared_ptr<std::string>& hashSHA1);
368 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
381 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
383 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
396 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
414 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
421 ome::compat::weak_ptr<ome::xml::model::Pixels>
429 const ome::compat::weak_ptr<ome::xml::model::Pixels>
438 setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
461 #endif // OME_XML_MODEL_PLANE_H void setPixels(ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: Plane.cpp:644
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > & getDeltaT()
Get the DeltaT property.
Definition: Plane.cpp:486
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > & getExposureTime()
Get the ExposureTime property.
Definition: Plane.cpp:402
void setExposureTime(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > &exposureTime)
Set the ExposureTime property.
Definition: Plane.cpp:416
const ome::compat::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Plane.cpp:582
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Plane.h:87
virtual common::xml::dom::Element asXMLElementInternal(common::xml::dom::Document &document, common::xml::dom::Element &element) const
Transform the object hierarchy rooted at this element to XML.
Definition: Plane.cpp:657
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
bool link(ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Plane.cpp:371
boost::multi_index_container< Ptr< T >, boost::multi_index::indexed_by< boost::multi_index::random_access<>, boost::multi_index::ordered_unique< boost::multi_index::identity< Ptr< T > >, ome::compat::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:94
const ome::xml::model::primitives::NonNegativeInteger & getTheC() const
Get the TheC property.
Definition: Plane.cpp:507
virtual ~Plane()
Destructor.
Definition: Plane.cpp:199
Plane()
Default constructor.
Definition: Plane.cpp:184
void setPositionX(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionX)
Set the PositionX property.
Definition: Plane.cpp:458
const ome::xml::model::primitives::NonNegativeInteger & getTheT() const
Get the TheT property.
Definition: Plane.cpp:535
virtual void update(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Update the object hierarchy recursively from an XML DOM tree.
Definition: Plane.cpp:228
void setTheT(const ome::xml::model::primitives::NonNegativeInteger &theT)
Set the TheT property.
Definition: Plane.cpp:542
void setTheZ(const ome::xml::model::primitives::NonNegativeInteger &theZ)
Set the TheZ property.
Definition: Plane.cpp:528
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Plane.cpp:570
const ome::xml::model::primitives::NonNegativeInteger & getTheZ() const
Get the TheZ property.
Definition: Plane.cpp:521
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
void setPositionY(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionY)
Set the PositionY property.
Definition: Plane.cpp:479
const std::string & elementName() const
Get the element name of this model object.
Definition: Plane.cpp:213
Open Microscopy Environment C++ implementation.
ome::compat::shared_ptr< std::string > getHashSHA1()
Get the HashSHA1 property.
Definition: Plane.cpp:549
Private implementation details of Plane model object.
Definition: Plane.cpp:75
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Plane.cpp:598
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Plane.cpp:220
void setPositionZ(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionZ)
Set the PositionZ property.
Definition: Plane.cpp:437
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionZ()
Get the PositionZ property.
Definition: Plane.cpp:423
A quantity of a defined unit.
Definition: Quantity.h:57
Plane model object.
Definition: Plane.h:84
ome::compat::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Plane.cpp:630
const ome::compat::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Plane.cpp:588
static ome::compat::shared_ptr< Plane > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Plane model object from DOM element.
Definition: Plane.cpp:204
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Plane.cpp:612
void setHashSHA1(ome::compat::shared_ptr< std::string > &hashSHA1)
Set the HashSHA1 property.
Definition: Plane.cpp:563
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Plane.cpp:650
void setDeltaT(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > &deltaT)
Set the DeltaT property.
Definition: Plane.cpp:500
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Plane.cpp:798
void setTheC(const ome::xml::model::primitives::NonNegativeInteger &theC)
Set the TheC property.
Definition: Plane.cpp:514
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionX()
Get the PositionX property.
Definition: Plane.cpp:444
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Plane.cpp:576
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionY()
Get the PositionY property.
Definition: Plane.cpp:465
Plane & operator=(const Plane &)
Assignment operator (deleted).