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> 61 #include <ome/xml/model/primitives/Quantity.h> 63 #include <ome/xml/model/Pixels.h> 64 #include <ome/xml/model/detail/OMEModelObject.h> 65 #include <ome/xml/model/enums/UnitsLength.h> 66 #include <ome/xml/model/enums/UnitsTime.h> 67 #include <ome/xml/model/primitives/NonNegativeInteger.h> 88 std::shared_ptr<Impl>
impl;
119 static std::shared_ptr<Plane>
149 link (std::shared_ptr<Reference>& reference,
150 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
157 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
165 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
181 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
189 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
205 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
213 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
229 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
237 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
253 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
261 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
325 std::shared_ptr<std::string>
333 const std::shared_ptr<std::string>
342 setHashSHA1 (std::shared_ptr<std::string>& hashSHA1);
367 const std::weak_ptr<ome::xml::model::Annotation>&
380 const std::weak_ptr<ome::xml::model::Annotation>&
382 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
395 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
413 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
420 std::weak_ptr<ome::xml::model::Pixels>
428 const std::weak_ptr<ome::xml::model::Pixels>
437 setPixels (std::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
455 #endif // OME_XML_MODEL_PLANE_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
static std::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
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > & getDeltaT()
Get the DeltaT property.
Definition: Plane.cpp:482
virtual void 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:646
void setExposureTime(const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > &exposureTime)
Set the ExposureTime property.
Definition: Plane.cpp:412
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Plane.cpp:572
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionX()
Get the PositionX property.
Definition: Plane.cpp:440
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.
Definition: Plane.cpp:578
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 > >, std::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:93
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
const ome::xml::model::primitives::NonNegativeInteger & getTheC() const
Get the TheC property.
Definition: Plane.cpp:503
virtual ~Plane()
Destructor.
Definition: Plane.cpp:199
Plane()
Default constructor.
Definition: Plane.cpp:184
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.
Definition: Plane.cpp:584
const ome::xml::model::primitives::NonNegativeInteger & getTheT() const
Get the TheT property.
Definition: Plane.cpp:531
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:226
void setTheT(const ome::xml::model::primitives::NonNegativeInteger &theT)
Set the TheT property.
Definition: Plane.cpp:538
void setDeltaT(const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > &deltaT)
Set the DeltaT property.
Definition: Plane.cpp:496
void setPositionX(const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionX)
Set the PositionX property.
Definition: Plane.cpp:454
void setTheZ(const ome::xml::model::primitives::NonNegativeInteger &theZ)
Set the TheZ property.
Definition: Plane.cpp:524
const ome::xml::model::primitives::NonNegativeInteger & getTheZ() const
Get the TheZ property.
Definition: Plane.cpp:517
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Plane.cpp:566
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
const std::string & elementName() const
Get the element name of this model object.
Definition: Plane.cpp:213
Open Microscopy Environment C++ implementation.
void setPositionZ(const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionZ)
Set the PositionZ property.
Definition: Plane.cpp:433
void setPositionY(const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionY)
Set the PositionY property.
Definition: Plane.cpp:475
Private implementation details of Plane model object.
Definition: Plane.cpp:75
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Plane.cpp:594
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
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionY()
Get the PositionY property.
Definition: Plane.cpp:461
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.
Definition: Plane.cpp:367
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > & getExposureTime()
Get the ExposureTime property.
Definition: Plane.cpp:398
A quantity of a defined unit.
Definition: Quantity.h:57
Plane model object.
Definition: Plane.h:83
void setPixels(std::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: Plane.cpp:640
void setHashSHA1(std::shared_ptr< std::string > &hashSHA1)
Set the HashSHA1 property.
Definition: Plane.cpp:559
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Plane.h:86
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionZ()
Get the PositionZ property.
Definition: Plane.cpp:419
std::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Plane.cpp:626
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Plane.cpp:766
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Plane.cpp:608
std::shared_ptr< std::string > getHashSHA1()
Get the HashSHA1 property.
Definition: Plane.cpp:545
void setTheC(const ome::xml::model::primitives::NonNegativeInteger &theC)
Set the TheC property.
Definition: Plane.cpp:510
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:118
Plane & operator=(const Plane &)
Assignment operator (deleted).