bioformats  5.1.0
Pixels.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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/MetadataOnly.h>
63 #include <ome/xml/model/detail/OMEModelObject.h>
64 #include <ome/xml/model/enums/DimensionOrder.h>
65 #include <ome/xml/model/enums/PixelType.h>
66 #include <ome/xml/model/primitives/PositiveFloat.h>
67 #include <ome/xml/model/primitives/PositiveInteger.h>
68 
69 namespace ome
70 {
71  namespace xml
72  {
73  namespace model
74  {
75 
76  // Forward declarations.
77  class Annotation;
78  class BinData;
79  class Channel;
80  class OMEModel;
81  class Plane;
82  class TiffData;
83 
88  {
89  private:
95  ome::compat::shared_ptr<double> timeIncrement;
97  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat> physicalSizeY;
99  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat> physicalSizeX;
101  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat> physicalSizeZ;
109  ome::compat::shared_ptr<bool> bigEndian;
111  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger> significantBits;
117  std::string id;
119  ome::compat::shared_ptr<bool> interleaved;
121  std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> > channels;
123  std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> > binDataBlocks;
125  std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> > tiffDataBlocks;
127  ome::compat::shared_ptr<ome::xml::model::MetadataOnly> metadataOnly;
129  std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> > planes;
132 
133  public:
135  Pixels ();
136 
142  Pixels (const Pixels& copy);
143 
145  virtual
146  ~Pixels ();
147 
148 
149 
164  static ome::compat::shared_ptr< Pixels>
165  create(const common::xml::dom::Element& element,
167 
168  // Documented in superclass.
169  const std::string&
170  elementName() const;
171 
172  // Documented in superclass.
173  bool
174  validElementName(const std::string& name) const;
175 
176 
177  // -- OMEModelObject API methods --
178 
180  virtual void
181  update(const common::xml::dom::Element& element,
183 
184  public:
185  // -- Pixels API methods --
186 
188  bool
189  link (ome::compat::shared_ptr<Reference>& reference,
190  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
191 
198  getSizeT () const;
199 
205  void
207 
215 
222  getDimensionOrder () const;
223 
229  void
231 
237  ome::compat::shared_ptr<double>
238  getTimeIncrement ();
239 
245  const ome::compat::shared_ptr<double>
246  getTimeIncrement () const;
247 
253  void
254  setTimeIncrement (ome::compat::shared_ptr<double>& timeIncrement);
255 
261  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
262  getPhysicalSizeY ();
263 
269  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
270  getPhysicalSizeY () const;
271 
277  void
278  setPhysicalSizeY (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>& physicalSizeY);
279 
285  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
286  getPhysicalSizeX ();
287 
293  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
294  getPhysicalSizeX () const;
295 
301  void
302  setPhysicalSizeX (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>& physicalSizeX);
303 
309  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
310  getPhysicalSizeZ ();
311 
317  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
318  getPhysicalSizeZ () const;
319 
325  void
326  setPhysicalSizeZ (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>& physicalSizeZ);
327 
334  getSizeX () const;
335 
341  void
343 
350  getSizeY () const;
351 
357  void
359 
366  getSizeZ () const;
367 
373  void
375 
381  ome::compat::shared_ptr<bool>
382  getBigEndian ();
383 
389  const ome::compat::shared_ptr<bool>
390  getBigEndian () const;
391 
397  void
398  setBigEndian (ome::compat::shared_ptr<bool>& bigEndian);
399 
405  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
407 
413  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
414  getSignificantBits () const;
415 
421  void
422  setSignificantBits (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& significantBits);
423 
430  getSizeC () const;
431 
437  void
439 
446  getType ();
447 
454  getType () const;
455 
461  void
463 
469  const std::string&
470  getID () const;
471 
477  void
478  setID (const std::string& id);
479 
485  ome::compat::shared_ptr<bool>
486  getInterleaved ();
487 
493  const ome::compat::shared_ptr<bool>
494  getInterleaved () const;
495 
501  void
502  setInterleaved (ome::compat::shared_ptr<bool>& interleaved);
503 
509  std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type
510  sizeOfChannelList () const;
511 
518  std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >&
519  getChannelList ();
520 
527  const std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >&
528  getChannelList () const;
529 
537  ome::compat::shared_ptr<ome::xml::model::Channel>&
538  getChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index);
539 
547  const ome::compat::shared_ptr<ome::xml::model::Channel>&
548  getChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index) const;
549 
557  void
558  setChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index,
559  ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
560 
569  void
570  addChannel (ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
571 
581  void
582  removeChannel (ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
583 
589  std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type
590  sizeOfBinDataList () const;
591 
598  std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
599  getBinDataList ();
600 
607  const std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
608  getBinDataList () const;
609 
617  ome::compat::shared_ptr<ome::xml::model::BinData>&
618  getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index);
619 
627  const ome::compat::shared_ptr<ome::xml::model::BinData>&
628  getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index) const;
629 
637  void
638  setBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index,
639  ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
640 
649  void
650  addBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
651 
661  void
662  removeBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
663 
669  std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type
670  sizeOfTiffDataList () const;
671 
678  std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >&
679  getTiffDataList ();
680 
687  const std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >&
688  getTiffDataList () const;
689 
697  ome::compat::shared_ptr<ome::xml::model::TiffData>&
698  getTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index);
699 
707  const ome::compat::shared_ptr<ome::xml::model::TiffData>&
708  getTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index) const;
709 
717  void
718  setTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index,
719  ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
720 
729  void
730  addTiffData (ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
731 
741  void
742  removeTiffData (ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
743 
749  ome::compat::shared_ptr<ome::xml::model::MetadataOnly>
750  getMetadataOnly ();
751 
757  const ome::compat::shared_ptr<ome::xml::model::MetadataOnly>
758  getMetadataOnly () const;
759 
765  void
766  setMetadataOnly (ome::compat::shared_ptr<ome::xml::model::MetadataOnly>& metadataOnly);
767 
773  std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type
774  sizeOfPlaneList () const;
775 
782  std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >&
783  getPlaneList ();
784 
791  const std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >&
792  getPlaneList () const;
793 
801  ome::compat::shared_ptr<ome::xml::model::Plane>&
802  getPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index);
803 
811  const ome::compat::shared_ptr<ome::xml::model::Plane>&
812  getPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index) const;
813 
821  void
822  setPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index,
823  ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
824 
833  void
834  addPlane (ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
835 
845  void
846  removePlane (ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
847 
855 
862  getLinkedAnnotationList () const;
863 
871  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
873 
884  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
886  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
887 
898  bool
899  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
900 
916  bool
917  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
918 
919 
922  asXMLElement (common::xml::dom::Document& document) const;
923 
924 
925  protected:
926  // Documented in base class.
929  common::xml::dom::Element& element) const;
930 
931  public:
932  // Documented in superclass.
933  const std::string&
934  getXMLNamespace() const;
935  };
936 
937  }
938  }
939 }
940 
941 #endif // OME_XML_MODEL_PIXELS_H
942 
943 /*
944  * Local Variables:
945  * mode:C++
946  * End:
947  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
const std::string & getID() const
Get the ID property.
Definition: Pixels.cpp:766
void addBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Add BinData.
Definition: Pixels.cpp:898
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > > planes
Plane property (occurs more than once)
Definition: Pixels.h:129
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type sizeOfChannelList() const
Get size of linked Channel list.
Definition: Pixels.cpp:801
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Pixels.cpp:1054
void setMetadataOnly(ome::compat::shared_ptr< ome::xml::model::MetadataOnly > &metadataOnly)
Set the MetadataOnly property.
Definition: Pixels.cpp:989
void setTimeIncrement(ome::compat::shared_ptr< double > &timeIncrement)
Set the TimeIncrement property.
Definition: Pixels.cpp:577
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Pixels.cpp:1082
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > physicalSizeZ
PhysicalSizeZ property.
Definition: Pixels.h:101
const ome::xml::model::primitives::PositiveInteger & getSizeX() const
Get the SizeX property.
Definition: Pixels.cpp:647
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getSignificantBits()
Get the SignificantBits property.
Definition: Pixels.cpp:710
ome::xml::model::primitives::PositiveInteger sizeC
SizeC property.
Definition: Pixels.h:113
ome::xml::model::primitives::PositiveInteger sizeY
SizeY property.
Definition: Pixels.h:105
const ome::xml::model::primitives::PositiveInteger & getSizeC() const
Get the SizeC property.
Definition: Pixels.cpp:731
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:889
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Pixels.cpp:267
void addTiffData(ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
Add TiffData.
Definition: Pixels.cpp:956
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:497
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > getPhysicalSizeZ()
Get the PhysicalSizeZ property.
Definition: Pixels.cpp:626
Pixels()
Default constructor.
Definition: Pixels.cpp:187
virtual ~Pixels()
Destructor.
Definition: Pixels.cpp:246
void setType(const ome::xml::model::enums::PixelType &type)
Set the Type property.
Definition: Pixels.cpp:759
ome::compat::shared_ptr< bool > bigEndian
BigEndian property.
Definition: Pixels.h:109
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Pixels.cpp:1060
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:1026
void removeBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Remove BinData.
Definition: Pixels.cpp:906
ome::xml::model::primitives::PositiveInteger sizeT
SizeT property.
Definition: Pixels.h:91
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type sizeOfPlaneList() const
Get size of linked Plane list.
Definition: Pixels.cpp:996
void removeTiffData(ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
Remove TiffData.
Definition: Pixels.cpp:964
void setPhysicalSizeX(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &physicalSizeX)
Set the PhysicalSizeX property.
Definition: Pixels.cpp:619
DOM Document wrapper.
Definition: Document.h:80
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > getPhysicalSizeY()
Get the PhysicalSizeY property.
Definition: Pixels.cpp:584
DOM Element wrapper.
Definition: Element.h:66
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:1002
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
void setSizeZ(const ome::xml::model::primitives::PositiveInteger &sizeZ)
Set the SizeZ property.
Definition: Pixels.cpp:682
void addChannel(ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
Add Channel.
Definition: Pixels.cpp:840
void setPhysicalSizeY(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &physicalSizeY)
Set the PhysicalSizeY property.
Definition: Pixels.cpp:598
ome::compat::shared_ptr< ome::xml::model::MetadataOnly > metadataOnly
MetadataOnly property.
Definition: Pixels.h:127
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Pixels.cpp:1387
void setSizeY(const ome::xml::model::primitives::PositiveInteger &sizeY)
Set the SizeY property.
Definition: Pixels.cpp:668
ome::xml::model::enums::PixelType & getType()
Get the Type property.
Definition: Pixels.cpp:745
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > > & getTiffDataList()
Get the TiffData list.
Definition: Pixels.cpp:923
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:947
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:935
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: Pixels.cpp:1072
ome::xml::model::enums::DimensionOrder dimensionOrder
DimensionOrder property.
Definition: Pixels.h:93
DimensionOrder enumeration.
Definition: DimensionOrder.h:70
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Pixels.cpp:1096
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > getPhysicalSizeX()
Get the PhysicalSizeX property.
Definition: Pixels.cpp:605
ome::compat::shared_ptr< bool > interleaved
Interleaved property.
Definition: Pixels.h:119
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
void setDimensionOrder(const ome::xml::model::enums::DimensionOrder &dimensionOrder)
Set the DimensionOrder property.
Definition: Pixels.cpp:556
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type sizeOfTiffDataList() const
Get size of linked TiffData list.
Definition: Pixels.cpp:917
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
ome::xml::model::primitives::PositiveInteger sizeX
SizeX property.
Definition: Pixels.h:103
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > > tiffDataBlocks
TiffData property (occurs more than once)
Definition: Pixels.h:125
ome::compat::shared_ptr< double > getTimeIncrement()
Get the TimeIncrement property.
Definition: Pixels.cpp:563
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
AnnotationRef reference (occurs more than once)
Definition: Pixels.h:131
void setSignificantBits(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &significantBits)
Set the SignificantBits property.
Definition: Pixels.cpp:724
ome::compat::shared_ptr< ome::xml::model::MetadataOnly > getMetadataOnly()
Get the MetadataOnly property.
Definition: Pixels.cpp:975
Pixels model object.
Definition: Pixels.h:87
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > binDataBlocks
BinData property (occurs more than once)
Definition: Pixels.h:123
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:276
const ome::xml::model::primitives::PositiveInteger & getSizeY() const
Get the SizeY property.
Definition: Pixels.cpp:661
ome::xml::model::primitives::PositiveInteger sizeZ
SizeZ property.
Definition: Pixels.h:107
void addPlane(ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
Add Plane.
Definition: Pixels.cpp:1035
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > physicalSizeX
PhysicalSizeX property.
Definition: Pixels.h:99
ome::compat::shared_ptr< bool > getInterleaved()
Get the Interleaved property.
Definition: Pixels.cpp:780
const ome::xml::model::primitives::PositiveInteger & getSizeT() const
Get the SizeT property.
Definition: Pixels.cpp:528
void setID(const std::string &id)
Set the ID property.
Definition: Pixels.cpp:773
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:251
PixelType enumeration.
Definition: PixelType.h:70
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:819
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > physicalSizeY
PhysicalSizeY property.
Definition: Pixels.h:97
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > & getBinDataList()
Get the BinData list.
Definition: Pixels.cpp:865
void setSizeC(const ome::xml::model::primitives::PositiveInteger &sizeC)
Set the SizeC property.
Definition: Pixels.cpp:738
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:1014
const ome::xml::model::primitives::PositiveInteger & getSizeZ() const
Get the SizeZ property.
Definition: Pixels.cpp:675
void setSizeT(const ome::xml::model::primitives::PositiveInteger &sizeT)
Set the SizeT property.
Definition: Pixels.cpp:535
void removeChannel(ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
Remove Channel.
Definition: Pixels.cpp:848
const std::string & elementName() const
Get the element name of this model object.
Definition: Pixels.cpp:260
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:831
ome::compat::shared_ptr< bool > getBigEndian()
Get the BigEndian property.
Definition: Pixels.cpp:689
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:1121
ome::compat::shared_ptr< double > timeIncrement
TimeIncrement property.
Definition: Pixels.h:95
ome::xml::model::enums::PixelType type
Type property.
Definition: Pixels.h:115
std::string id
ID property.
Definition: Pixels.h:117
void setPhysicalSizeZ(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &physicalSizeZ)
Set the PhysicalSizeZ property.
Definition: Pixels.cpp:640
Boost.Log compatibility.
ome::xml::model::enums::DimensionOrder & getDimensionOrder()
Get the DimensionOrder property.
Definition: Pixels.cpp:542
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:877
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > > & getChannelList()
Get the Channel list.
Definition: Pixels.cpp:807
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:1114
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type sizeOfBinDataList() const
Get size of linked BinData list.
Definition: Pixels.cpp:859
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::PositiveInteger > significantBits
SignificantBits property.
Definition: Pixels.h:111
void removePlane(ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
Remove Plane.
Definition: Pixels.cpp:1043
void setInterleaved(ome::compat::shared_ptr< bool > &interleaved)
Set the Interleaved property.
Definition: Pixels.cpp:794
Xerces-C modern C++ wrapper.
Definition: Base.h:53
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: Pixels.cpp:1066
void setSizeX(const ome::xml::model::primitives::PositiveInteger &sizeX)
Set the SizeX property.
Definition: Pixels.cpp:654
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > > channels
Channel property (occurs more than once)
Definition: Pixels.h:121
void setBigEndian(ome::compat::shared_ptr< bool > &bigEndian)
Set the BigEndian property.
Definition: Pixels.cpp:703