46 #ifndef OME_XML_MODEL_PIXELS_H 47 #define OME_XML_MODEL_PIXELS_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/MetadataOnly.h> 65 #include <ome/xml/model/detail/OMEModelObject.h> 66 #include <ome/xml/model/enums/DimensionOrder.h> 67 #include <ome/xml/model/enums/PixelType.h> 68 #include <ome/xml/model/enums/UnitsLength.h> 69 #include <ome/xml/model/enums/UnitsTime.h> 70 #include <ome/xml/model/primitives/PositiveFloat.h> 71 #include <ome/xml/model/primitives/PositiveInteger.h> 95 ome::compat::shared_ptr<Impl>
impl;
126 static ome::compat::shared_ptr< Pixels>
156 link (ome::compat::shared_ptr<Reference>& reference,
157 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
204 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
212 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
228 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
236 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
252 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
260 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
324 ome::compat::shared_ptr<bool>
332 const ome::compat::shared_ptr<bool>
341 setBigEndian (ome::compat::shared_ptr<bool>& bigEndian);
348 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
356 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
372 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
380 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
389 setSignificantBits (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& significantBits);
445 setID (
const std::string&
id);
452 ome::compat::shared_ptr<bool>
460 const ome::compat::shared_ptr<bool>
476 std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type
485 std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >&
494 const std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >&
504 ome::compat::shared_ptr<ome::xml::model::Channel>&
505 getChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index);
514 const ome::compat::shared_ptr<ome::xml::model::Channel>&
515 getChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index)
const;
525 setChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index,
526 ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
537 addChannel (ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
549 removeChannel (ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
556 std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type
565 std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
574 const std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
584 ome::compat::shared_ptr<ome::xml::model::BinData>&
585 getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index);
594 const ome::compat::shared_ptr<ome::xml::model::BinData>&
595 getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index)
const;
605 setBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index,
606 ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
617 addBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
629 removeBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
636 std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type
645 std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >&
654 const std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >&
664 ome::compat::shared_ptr<ome::xml::model::TiffData>&
665 getTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index);
674 const ome::compat::shared_ptr<ome::xml::model::TiffData>&
675 getTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index)
const;
685 setTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index,
686 ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
697 addTiffData (ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
709 removeTiffData (ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
716 ome::compat::shared_ptr<ome::xml::model::MetadataOnly>
724 const ome::compat::shared_ptr<ome::xml::model::MetadataOnly>
733 setMetadataOnly (ome::compat::shared_ptr<ome::xml::model::MetadataOnly>& metadataOnly);
740 std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type
749 std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >&
758 const std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >&
768 ome::compat::shared_ptr<ome::xml::model::Plane>&
769 getPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index);
778 const ome::compat::shared_ptr<ome::xml::model::Plane>&
779 getPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index)
const;
789 setPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index,
790 ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
801 addPlane (ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
813 removePlane (ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
836 #endif // OME_XML_MODEL_PIXELS_H Private implementation details of Pixels model object.
Definition: Pixels.cpp:103
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
const std::string & getID() const
Get the ID property.
Definition: Pixels.cpp:812
void addBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Add BinData.
Definition: Pixels.cpp:944
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type sizeOfChannelList() const
Get size of linked Channel list.
Definition: Pixels.cpp:847
void setMetadataOnly(ome::compat::shared_ptr< ome::xml::model::MetadataOnly > &metadataOnly)
Set the MetadataOnly property.
Definition: Pixels.cpp:1035
const ome::xml::model::primitives::PositiveInteger & getSizeX() const
Get the SizeX property.
Definition: Pixels.cpp:672
void setPhysicalSizeZ(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > &physicalSizeZ)
Set the PhysicalSizeZ property.
Definition: Pixels.cpp:623
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getSignificantBits()
Get the SignificantBits property.
Definition: Pixels.cpp:756
const ome::xml::model::primitives::PositiveInteger & getSizeC() const
Get the SizeC property.
Definition: Pixels.cpp:777
void setBinData(std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index, ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Set BinData.
Definition: Pixels.cpp:935
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Pixels.cpp:317
void setPhysicalSizeY(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > &physicalSizeY)
Set the PhysicalSizeY property.
Definition: Pixels.cpp:644
void addTiffData(ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
Add TiffData.
Definition: Pixels.cpp:1002
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: Pixels.cpp:559
Pixels()
Default constructor.
Definition: Pixels.cpp:277
virtual ~Pixels()
Destructor.
Definition: Pixels.cpp:296
void setType(const ome::xml::model::enums::PixelType &type)
Set the Type property.
Definition: Pixels.cpp:805
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > & getTimeIncrement()
Get the TimeIncrement property.
Definition: Pixels.cpp:735
void setPlane(std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
Set Plane.
Definition: Pixels.cpp:1072
void removeBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Remove BinData.
Definition: Pixels.cpp:952
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type sizeOfPlaneList() const
Get size of linked Plane list.
Definition: Pixels.cpp:1042
void removeTiffData(ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
Remove TiffData.
Definition: Pixels.cpp:1010
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > > & getPlaneList()
Get the Plane list.
Definition: Pixels.cpp:1048
void setSizeZ(const ome::xml::model::primitives::PositiveInteger &sizeZ)
Set the SizeZ property.
Definition: Pixels.cpp:707
void addChannel(ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
Add Channel.
Definition: Pixels.cpp:886
Pixels & operator=(const Pixels &)
Assignment operator (deleted).
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Pixels.h:93
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Pixels.cpp:1350
void setSizeY(const ome::xml::model::primitives::PositiveInteger &sizeY)
Set the SizeY property.
Definition: Pixels.cpp:693
ome::xml::model::enums::PixelType & getType()
Get the Type property.
Definition: Pixels.cpp:791
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > > & getTiffDataList()
Get the TiffData list.
Definition: Pixels.cpp:969
void setTiffData(std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type index, ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
Set TiffData.
Definition: Pixels.cpp:993
ome::compat::shared_ptr< ome::xml::model::TiffData > & getTiffData(std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type index)
Get TiffData.
Definition: Pixels.cpp:981
DimensionOrder enumeration.
Definition: DimensionOrder.h:72
void setDimensionOrder(const ome::xml::model::enums::DimensionOrder &dimensionOrder)
Set the DimensionOrder property.
Definition: Pixels.cpp:602
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type sizeOfTiffDataList() const
Get size of linked TiffData list.
Definition: Pixels.cpp:963
Open Microscopy Environment C++ implementation.
void setSignificantBits(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &significantBits)
Set the SignificantBits property.
Definition: Pixels.cpp:770
ome::compat::shared_ptr< ome::xml::model::MetadataOnly > getMetadataOnly()
Get the MetadataOnly property.
Definition: Pixels.cpp:1021
Pixels model object.
Definition: Pixels.h:90
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & getPhysicalSizeX()
Get the PhysicalSizeX property.
Definition: Pixels.cpp:651
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: Pixels.cpp:325
const ome::xml::model::primitives::PositiveInteger & getSizeY() const
Get the SizeY property.
Definition: Pixels.cpp:686
void addPlane(ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
Add Plane.
Definition: Pixels.cpp:1081
ome::compat::shared_ptr< bool > getInterleaved()
Get the Interleaved property.
Definition: Pixels.cpp:826
const ome::xml::model::primitives::PositiveInteger & getSizeT() const
Get the SizeT property.
Definition: Pixels.cpp:574
void setID(const std::string &id)
Set the ID property.
Definition: Pixels.cpp:819
static ome::compat::shared_ptr< Pixels > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Pixels model object from DOM element.
Definition: Pixels.cpp:301
PixelType enumeration.
Definition: PixelType.h:72
ome::compat::shared_ptr< ome::xml::model::Channel > & getChannel(std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type index)
Get Channel.
Definition: Pixels.cpp:865
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & getPhysicalSizeZ()
Get the PhysicalSizeZ property.
Definition: Pixels.cpp:609
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & getPhysicalSizeY()
Get the PhysicalSizeY property.
Definition: Pixels.cpp:630
A quantity of a defined unit.
Definition: Quantity.h:57
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > & getBinDataList()
Get the BinData list.
Definition: Pixels.cpp:911
void setSizeC(const ome::xml::model::primitives::PositiveInteger &sizeC)
Set the SizeC property.
Definition: Pixels.cpp:784
ome::compat::shared_ptr< ome::xml::model::Plane > & getPlane(std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type index)
Get Plane.
Definition: Pixels.cpp:1060
const ome::xml::model::primitives::PositiveInteger & getSizeZ() const
Get the SizeZ property.
Definition: Pixels.cpp:700
void setSizeT(const ome::xml::model::primitives::PositiveInteger &sizeT)
Set the SizeT property.
Definition: Pixels.cpp:581
void setPhysicalSizeX(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > &physicalSizeX)
Set the PhysicalSizeX property.
Definition: Pixels.cpp:665
void removeChannel(ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
Remove Channel.
Definition: Pixels.cpp:894
const std::string & elementName() const
Get the element name of this model object.
Definition: Pixels.cpp:310
void setChannel(std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
Set Channel.
Definition: Pixels.cpp:877
ome::compat::shared_ptr< bool > getBigEndian()
Get the BigEndian property.
Definition: Pixels.cpp:714
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: Pixels.cpp:1106
void setTimeIncrement(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > &timeIncrement)
Set the TimeIncrement property.
Definition: Pixels.cpp:749
ome::xml::model::enums::DimensionOrder & getDimensionOrder()
Get the DimensionOrder property.
Definition: Pixels.cpp:588
ome::compat::shared_ptr< ome::xml::model::BinData > & getBinData(std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index)
Get BinData.
Definition: Pixels.cpp:923
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > > & getChannelList()
Get the Channel list.
Definition: Pixels.cpp:853
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Pixels.cpp:1099
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type sizeOfBinDataList() const
Get size of linked BinData list.
Definition: Pixels.cpp:905
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119
void removePlane(ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
Remove Plane.
Definition: Pixels.cpp:1089
void setInterleaved(ome::compat::shared_ptr< bool > &interleaved)
Set the Interleaved property.
Definition: Pixels.cpp:840
void setSizeX(const ome::xml::model::primitives::PositiveInteger &sizeX)
Set the SizeX property.
Definition: Pixels.cpp:679
void setBigEndian(ome::compat::shared_ptr< bool > &bigEndian)
Set the BigEndian property.
Definition: Pixels.cpp:728