ome-xml 5.2.3

Pixels.h
1 /*
2 * #%L
3 * OME-XML C++ library for working with OME-XML metadata structures.
4 * %%
5 * Copyright © 2006 - 2016 Open Microscopy Environment:
6 * - Massachusetts Institute of Technology
7 * - National Institutes of Health
8 * - University of Dundee
9 * - Board of Regents of the University of Wisconsin-Madison
10 * - Glencoe Software, Inc.
11 * %%
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 * The views and conclusions contained in the software and documentation are
34 * those of the authors and should not be interpreted as representing official
35 * policies, either expressed or implied, of any organization.
36 * #L%
37 */
38
39 /*─────────────────────────────────────────────────────────────────────────────
40 *
41 * THIS IS AUTOMATICALLY GENERATED CODE. DO NOT MODIFY.
42 *
43 *─────────────────────────────────────────────────────────────────────────────
44 */
45
46 #ifndef OME_XML_MODEL_PIXELS_H
47 #define OME_XML_MODEL_PIXELS_H
48
49 #include <algorithm>
50 #include <list>
51 #include <stdexcept>
52 #include <string>
53 #include <vector>
54
55 #include <ome/common/log.h>
56
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>
61
62 #include <ome/xml/model/primitives/Quantity.h>
63
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>
72
73 namespace ome
74 {
75 namespace xml
76 {
77 namespace model
78 {
79
80 // Forward declarations.
81 class BinData;
82 class Channel;
83 class OMEModel;
84 class Plane;
85 class TiffData;
86
90 class Pixels : public detail::OMEModelObject
91 {
92 private:
93 class Impl;
95 ome::compat::shared_ptr<Impl> impl;
96
97 public:
99 Pixels();
100
106 Pixels (const Pixels& copy);
107
109 virtual
110 ~Pixels ();
111
126 static ome::compat::shared_ptr< Pixels>
127 create(const common::xml::dom::Element& element,
128 ome::xml::model::OMEModel& model);
129
130 // Documented in superclass.
131 const std::string&
132 elementName() const;
133
134 // Documented in superclass.
135 bool
136 validElementName(const std::string& name) const;
137
138 private:
140 Pixels&
141 operator= (const Pixels&);
142
143 public:
144 // -- OMEModelObject API methods --
145
147 virtual void
148 update(const common::xml::dom::Element& element,
149 ome::xml::model::OMEModel& model);
150
151 public:
152 // -- Pixels API methods --
153
155 bool
156 link (ome::compat::shared_ptr<Reference>& reference,
157 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
158
164 const ome::xml::model::primitives::PositiveInteger&
165 getSizeT () const;
166
172 void
173 setSizeT (const ome::xml::model::primitives::PositiveInteger& sizeT);
174
180 ome::xml::model::enums::DimensionOrder&
181 getDimensionOrder ();
182
188 const ome::xml::model::enums::DimensionOrder&
189 getDimensionOrder () const;
190
196 void
197 setDimensionOrder (const ome::xml::model::enums::DimensionOrder& dimensionOrder);
198
204 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
205 getPhysicalSizeZ ();
206
212 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
213 getPhysicalSizeZ () const;
214
220 void
221 setPhysicalSizeZ (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >& physicalSizeZ);
222
228 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
229 getPhysicalSizeY ();
230
236 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
237 getPhysicalSizeY () const;
238
244 void
245 setPhysicalSizeY (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >& physicalSizeY);
246
252 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
253 getPhysicalSizeX ();
254
260 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
261 getPhysicalSizeX () const;
262
268 void
269 setPhysicalSizeX (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >& physicalSizeX);
270
276 const ome::xml::model::primitives::PositiveInteger&
277 getSizeX () const;
278
284 void
285 setSizeX (const ome::xml::model::primitives::PositiveInteger& sizeX);
286
292 const ome::xml::model::primitives::PositiveInteger&
293 getSizeY () const;
294
300 void
301 setSizeY (const ome::xml::model::primitives::PositiveInteger& sizeY);
302
308 const ome::xml::model::primitives::PositiveInteger&
309 getSizeZ () const;
310
316 void
317 setSizeZ (const ome::xml::model::primitives::PositiveInteger& sizeZ);
318
324 ome::compat::shared_ptr<bool>
325 getBigEndian ();
326
332 const ome::compat::shared_ptr<bool>
333 getBigEndian () const;
334
340 void
341 setBigEndian (ome::compat::shared_ptr<bool>& bigEndian);
342
348 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
349 getTimeIncrement ();
350
356 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
357 getTimeIncrement () const;
358
364 void
365 setTimeIncrement (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >& timeIncrement);
366
372 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
373 getSignificantBits ();
374
380 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
381 getSignificantBits () const;
382
388 void
389 setSignificantBits (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& significantBits);
390
396 const ome::xml::model::primitives::PositiveInteger&
397 getSizeC () const;
398
404 void
405 setSizeC (const ome::xml::model::primitives::PositiveInteger& sizeC);
406
412 ome::xml::model::enums::PixelType&
413 getType ();
414
420 const ome::xml::model::enums::PixelType&
421 getType () const;
422
428 void
429 setType (const ome::xml::model::enums::PixelType& type);
430
436 const std::string&
437 getID () const;
438
444 void
445 setID (const std::string& id);
446
452 ome::compat::shared_ptr<bool>
453 getInterleaved ();
454
460 const ome::compat::shared_ptr<bool>
461 getInterleaved () const;
462
468 void
469 setInterleaved (ome::compat::shared_ptr<bool>& interleaved);
470
476 std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type
477 sizeOfChannelList () const;
478
485 std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >&
486 getChannelList ();
487
494 const std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >&
495 getChannelList () const;
496
504 ome::compat::shared_ptr<ome::xml::model::Channel>&
505 getChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index);
506
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;
516
524 void
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);
527
536 void
537 addChannel (ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
538
548 void
549 removeChannel (ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
550
556 std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type
557 sizeOfBinDataList () const;
558
565 std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
566 getBinDataList ();
567
574 const std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
575 getBinDataList () const;
576
584 ome::compat::shared_ptr<ome::xml::model::BinData>&
585 getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index);
586
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;
596
604 void
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);
607
616 void
617 addBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
618
628 void
629 removeBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
630
636 std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type
637 sizeOfTiffDataList () const;
638
645 std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >&
646 getTiffDataList ();
647
654 const std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >&
655 getTiffDataList () const;
656
664 ome::compat::shared_ptr<ome::xml::model::TiffData>&
665 getTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index);
666
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;
676
684 void
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);
687
696 void
697 addTiffData (ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
698
708 void
709 removeTiffData (ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
710
716 ome::compat::shared_ptr<ome::xml::model::MetadataOnly>
717 getMetadataOnly ();
718
724 const ome::compat::shared_ptr<ome::xml::model::MetadataOnly>
725 getMetadataOnly () const;
726
732 void
733 setMetadataOnly (ome::compat::shared_ptr<ome::xml::model::MetadataOnly>& metadataOnly);
734
740 std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type
741 sizeOfPlaneList () const;
742
749 std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >&
750 getPlaneList ();
751
758 const std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >&
759 getPlaneList () const;
760
768 ome::compat::shared_ptr<ome::xml::model::Plane>&
769 getPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index);
770
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;
780
788 void
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);
791
800 void
801 addPlane (ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
802
812 void
813 removePlane (ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
814
816 virtual common::xml::dom::Element
817 asXMLElement (common::xml::dom::Document& document) const;
818
819
820 protected:
821 // Documented in base class.
822 virtual common::xml::dom::Element
823 asXMLElementInternal (common::xml::dom::Document& document,
824 common::xml::dom::Element& element) const;
825
826 public:
827 // Documented in superclass.
828 const std::string&
829 getXMLNamespace() const;
830 };
831
832 }
833 }
834 }
835
836 #endif // OME_XML_MODEL_PIXELS_H
837
838 /*
839 * Local Variables:
840 * mode:C++
841 * End:
842 */
ome::xml::model::Pixels::Impl
Private implementation details of Pixels model object.
Definition: Pixels.cpp:103
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Pixels::addBinData
void addBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Add BinData.
Definition: Pixels.cpp:940
ome::xml::model::Pixels::getSizeT
const ome::xml::model::primitives::PositiveInteger & getSizeT() const
Get the SizeT property.
Definition: Pixels.cpp:570
ome::xml::model::Pixels::setMetadataOnly
void setMetadataOnly(ome::compat::shared_ptr< ome::xml::model::MetadataOnly > &metadataOnly)
Set the MetadataOnly property.
Definition: Pixels.cpp:1031
ome::xml::model::Pixels::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Pixels.cpp:313
ome::xml::model::Pixels::setPhysicalSizeZ
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:619
ome::xml::model::Pixels::getSignificantBits
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getSignificantBits()
Get the SignificantBits property.
Definition: Pixels.cpp:752
ome::xml::model::Pixels::setBinData
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:931
ome::xml::model::Pixels::setPhysicalSizeY
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:640
ome::xml::model::Pixels::addTiffData
void addTiffData(ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
Add TiffData.
Definition: Pixels.cpp:998
ome::xml::model::Pixels::sizeOfTiffDataList
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type sizeOfTiffDataList() const
Get size of linked TiffData list.
Definition: Pixels.cpp:959
ome::xml::model::Pixels::link
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:555
ome::xml::model::Pixels::Pixels
Pixels()
Default constructor.
Definition: Pixels.cpp:277
ome::xml::model::Pixels::asXMLElement
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:1095
ome::xml::model::Pixels::~Pixels
virtual ~Pixels()
Destructor.
Definition: Pixels.cpp:292
ome::xml::model::Pixels::setType
void setType(const ome::xml::model::enums::PixelType &type)
Set the Type property.
Definition: Pixels.cpp:801
ome::xml::model::Pixels::getTimeIncrement
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > & getTimeIncrement()
Get the TimeIncrement property.
Definition: Pixels.cpp:731
ome::xml::model::Pixels::getSizeY
const ome::xml::model::primitives::PositiveInteger & getSizeY() const
Get the SizeY property.
Definition: Pixels.cpp:682
ome::xml::model::Pixels::setPlane
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:1068
ome::xml::model::Pixels::removeBinData
void removeBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Remove BinData.
Definition: Pixels.cpp:948
ome::xml::model::Pixels::removeTiffData
void removeTiffData(ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
Remove TiffData.
Definition: Pixels.cpp:1006
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Pixels::getPlaneList
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > > & getPlaneList()
Get the Plane list.
Definition: Pixels.cpp:1044
ome::xml::model::Pixels::setSizeZ
void setSizeZ(const ome::xml::model::primitives::PositiveInteger &sizeZ)
Set the SizeZ property.
Definition: Pixels.cpp:703
ome::xml::model::Pixels::addChannel
void addChannel(ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
Add Channel.
Definition: Pixels.cpp:882
ome::xml::model::Pixels::operator=
Pixels & operator=(const Pixels &)
Assignment operator (deleted).
ome::xml::model::Pixels::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Pixels.cpp:1346
ome::xml::model::Pixels::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Pixels.h:93
ome::xml::model::Pixels::getSizeX
const ome::xml::model::primitives::PositiveInteger & getSizeX() const
Get the SizeX property.
Definition: Pixels.cpp:668
ome::xml::model::Pixels::setSizeY
void setSizeY(const ome::xml::model::primitives::PositiveInteger &sizeY)
Set the SizeY property.
Definition: Pixels.cpp:689
ome::xml::model::Pixels::getType
ome::xml::model::enums::PixelType & getType()
Get the Type property.
Definition: Pixels.cpp:787
ome::xml::model::Pixels::getTiffDataList
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > > & getTiffDataList()
Get the TiffData list.
Definition: Pixels.cpp:965
ome::xml::model::Pixels::setTiffData
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:989
ome::xml::model::Pixels::getTiffData
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:977
ome::xml::model::enums::DimensionOrder
DimensionOrder enumeration.
Definition: DimensionOrder.h:72
ome::xml::model::Pixels::sizeOfBinDataList
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type sizeOfBinDataList() const
Get size of linked BinData list.
Definition: Pixels.cpp:901
ome::xml::model::Pixels::setDimensionOrder
void setDimensionOrder(const ome::xml::model::enums::DimensionOrder &dimensionOrder)
Set the DimensionOrder property.
Definition: Pixels.cpp:598
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Pixels::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Pixels.cpp:306
ome::xml::model::Pixels::getID
const std::string & getID() const
Get the ID property.
Definition: Pixels.cpp:808
ome::xml::model::Pixels::setSignificantBits
void setSignificantBits(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &significantBits)
Set the SignificantBits property.
Definition: Pixels.cpp:766
ome::xml::model::Pixels::getMetadataOnly
ome::compat::shared_ptr< ome::xml::model::MetadataOnly > getMetadataOnly()
Get the MetadataOnly property.
Definition: Pixels.cpp:1017
ome::xml::model::Pixels
Pixels model object.
Definition: Pixels.h:90
ome::xml::model::Pixels::getPhysicalSizeX
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:647
ome::xml::model::Pixels::asXMLElementInternal
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:1102
ome::xml::model::Pixels::sizeOfPlaneList
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type sizeOfPlaneList() const
Get size of linked Plane list.
Definition: Pixels.cpp:1038
ome::xml::model::Pixels::update
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:321
ome::xml::model::Pixels::addPlane
void addPlane(ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
Add Plane.
Definition: Pixels.cpp:1077
ome::xml::model::Pixels::getInterleaved
ome::compat::shared_ptr< bool > getInterleaved()
Get the Interleaved property.
Definition: Pixels.cpp:822
ome::xml::model::Pixels::setID
void setID(const std::string &id)
Set the ID property.
Definition: Pixels.cpp:815
ome::xml::model::Pixels::create
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:297
ome::xml::model::Pixels::getSizeZ
const ome::xml::model::primitives::PositiveInteger & getSizeZ() const
Get the SizeZ property.
Definition: Pixels.cpp:696
ome::xml::model::Pixels::getSizeC
const ome::xml::model::primitives::PositiveInteger & getSizeC() const
Get the SizeC property.
Definition: Pixels.cpp:773
ome::xml::model::enums::PixelType
PixelType enumeration.
Definition: PixelType.h:72
ome::xml::model::Pixels::getChannel
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:861
ome::xml::model::Pixels::getPhysicalSizeZ
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:605
ome::xml::model::Pixels::getPhysicalSizeY
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:626
ome::xml::model::primitives::Quantity
A quantity of a defined unit.
Definition: Quantity.h:57
ome::xml::model::Pixels::getBinDataList
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > & getBinDataList()
Get the BinData list.
Definition: Pixels.cpp:907
ome::xml::model::Pixels::setSizeC
void setSizeC(const ome::xml::model::primitives::PositiveInteger &sizeC)
Set the SizeC property.
Definition: Pixels.cpp:780
ome::xml::model::Pixels::getPlane
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:1056
ome::xml::model::Pixels::setSizeT
void setSizeT(const ome::xml::model::primitives::PositiveInteger &sizeT)
Set the SizeT property.
Definition: Pixels.cpp:577
ome::xml::model::Pixels::setPhysicalSizeX
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:661
ome::xml::model::Pixels::removeChannel
void removeChannel(ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
Remove Channel.
Definition: Pixels.cpp:890
ome::xml::model::Pixels::setChannel
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:873
ome::xml::model::Pixels::getBigEndian
ome::compat::shared_ptr< bool > getBigEndian()
Get the BigEndian property.
Definition: Pixels.cpp:710
ome::xml::model::Pixels::setTimeIncrement
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:745
ome::xml::model::Pixels::getDimensionOrder
ome::xml::model::enums::DimensionOrder & getDimensionOrder()
Get the DimensionOrder property.
Definition: Pixels.cpp:584
log.h
ome::xml::model::Pixels::getBinData
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:919
ome::xml::model::Pixels::getChannelList
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > > & getChannelList()
Get the Channel list.
Definition: Pixels.cpp:849
ome::xml::model::Pixels::sizeOfChannelList
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type sizeOfChannelList() const
Get size of linked Channel list.
Definition: Pixels.cpp:843
ome::xml::model::primitives::ConstrainedNumeric
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119
ome::xml::model::Pixels::removePlane
void removePlane(ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
Remove Plane.
Definition: Pixels.cpp:1085
ome::xml::model::Pixels::setInterleaved
void setInterleaved(ome::compat::shared_ptr< bool > &interleaved)
Set the Interleaved property.
Definition: Pixels.cpp:836
ome::xml::model::Pixels::setSizeX
void setSizeX(const ome::xml::model::primitives::PositiveInteger &sizeX)
Set the SizeX property.
Definition: Pixels.cpp:675
ome::xml::model::Pixels::setBigEndian
void setBigEndian(ome::compat::shared_ptr< bool > &bigEndian)
Set the BigEndian property.
Definition: Pixels.cpp:724