ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

Shape.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_SHAPE_H
47 #define OME_XML_MODEL_SHAPE_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/AffineTransform.h>
63 #include <ome/xml/model/Union.h>
64 #include <ome/xml/model/detail/OMEModelObject.h>
65 #include <ome/xml/model/enums/FillRule.h>
66 #include <ome/xml/model/enums/FontFamily.h>
67 #include <ome/xml/model/enums/FontStyle.h>
68 #include <ome/xml/model/enums/LineCap.h>
69 #include <ome/xml/model/primitives/Color.h>
70 #include <ome/xml/model/primitives/NonNegativeInteger.h>
71
72 namespace ome
73 {
74 namespace xml
75 {
76 namespace model
77 {
78
79 // Forward declarations.
80 class OMEModel;
81
85 class Shape : public detail::OMEModelObject
86 {
87 private:
88 class Impl;
90 ome::compat::shared_ptr<Impl> impl;
91
92 public:
94 Shape();
95
101 Shape (const Shape& copy);
102
104 virtual
105 ~Shape ();
106
107
108 // Documented in superclass.
109 bool
110 validElementName(const std::string& name) const;
111
112
113 // -- OMEModelObject API methods --
114
116 virtual void
117 update(const common::xml::dom::Element& element,
118 ome::xml::model::OMEModel& model);
119
120 public:
121 // -- Shape API methods --
122
124 bool
125 link (ome::compat::shared_ptr<Reference>& reference,
126 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
127
133 ome::compat::shared_ptr<std::string>
134 getStrokeDashArray ();
135
141 const ome::compat::shared_ptr<std::string>
142 getStrokeDashArray () const;
143
149 void
150 setStrokeDashArray (ome::compat::shared_ptr<std::string>& strokeDashArray);
151
157 ome::compat::shared_ptr<double>
158 getStrokeWidth ();
159
165 const ome::compat::shared_ptr<double>
166 getStrokeWidth () const;
167
173 void
174 setStrokeWidth (ome::compat::shared_ptr<double>& strokeWidth);
175
181 ome::compat::shared_ptr<bool>
182 getLocked ();
183
189 const ome::compat::shared_ptr<bool>
190 getLocked () const;
191
197 void
198 setLocked (ome::compat::shared_ptr<bool>& locked);
199
205 ome::compat::shared_ptr<ome::xml::model::enums::FillRule>
206 getFillRule ();
207
213 const ome::compat::shared_ptr<ome::xml::model::enums::FillRule>
214 getFillRule () const;
215
221 void
222 setFillRule (ome::compat::shared_ptr<ome::xml::model::enums::FillRule>& fillRule);
223
229 ome::compat::shared_ptr<bool>
230 getVisible ();
231
237 const ome::compat::shared_ptr<bool>
238 getVisible () const;
239
245 void
246 setVisible (ome::compat::shared_ptr<bool>& visible);
247
253 ome::compat::shared_ptr<ome::xml::model::enums::LineCap>
254 getLineCap ();
255
261 const ome::compat::shared_ptr<ome::xml::model::enums::LineCap>
262 getLineCap () const;
263
269 void
270 setLineCap (ome::compat::shared_ptr<ome::xml::model::enums::LineCap>& lineCap);
271
277 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
278 getTheC ();
279
285 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
286 getTheC () const;
287
293 void
294 setTheC (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& theC);
295
301 ome::compat::shared_ptr<ome::xml::model::enums::FontFamily>
302 getFontFamily ();
303
309 const ome::compat::shared_ptr<ome::xml::model::enums::FontFamily>
310 getFontFamily () const;
311
317 void
318 setFontFamily (ome::compat::shared_ptr<ome::xml::model::enums::FontFamily>& fontFamily);
319
325 ome::compat::shared_ptr<ome::xml::model::enums::FontStyle>
326 getFontStyle ();
327
333 const ome::compat::shared_ptr<ome::xml::model::enums::FontStyle>
334 getFontStyle () const;
335
341 void
342 setFontStyle (ome::compat::shared_ptr<ome::xml::model::enums::FontStyle>& fontStyle);
343
349 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
350 getFontSize ();
351
357 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
358 getFontSize () const;
359
365 void
366 setFontSize (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& fontSize);
367
373 ome::compat::shared_ptr<ome::xml::model::primitives::Color>
374 getFillColor ();
375
381 const ome::compat::shared_ptr<ome::xml::model::primitives::Color>
382 getFillColor () const;
383
389 void
390 setFillColor (ome::compat::shared_ptr<ome::xml::model::primitives::Color>& fillColor);
391
397 ome::compat::shared_ptr<std::string>
398 getText ();
399
405 const ome::compat::shared_ptr<std::string>
406 getText () const;
407
413 void
414 setText (ome::compat::shared_ptr<std::string>& text);
415
421 ome::compat::shared_ptr<ome::xml::model::primitives::Color>
422 getStrokeColor ();
423
429 const ome::compat::shared_ptr<ome::xml::model::primitives::Color>
430 getStrokeColor () const;
431
437 void
438 setStrokeColor (ome::compat::shared_ptr<ome::xml::model::primitives::Color>& strokeColor);
439
445 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
446 getTheT ();
447
453 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
454 getTheT () const;
455
461 void
462 setTheT (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& theT);
463
469 const std::string&
470 getID () const;
471
477 void
478 setID (const std::string& id);
479
485 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
486 getTheZ ();
487
493 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
494 getTheZ () const;
495
501 void
502 setTheZ (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& theZ);
503
504
505
506
507
508
509
510
511
517 ome::compat::shared_ptr<ome::xml::model::AffineTransform>
518 getTransform ();
519
525 const ome::compat::shared_ptr<ome::xml::model::AffineTransform>
526 getTransform () const;
527
533 void
534 setTransform (ome::compat::shared_ptr<ome::xml::model::AffineTransform>& transform);
535
541 ome::compat::weak_ptr<ome::xml::model::Union>
542 getUnion ();
543
549 const ome::compat::weak_ptr<ome::xml::model::Union>
550 getUnion () const;
551
557 void
558 setUnion (ome::compat::weak_ptr<ome::xml::model::Union>& union_BackReference);
559
565 virtual const std::string&
566 getShapeType() const = 0;
567
568
569 protected:
570 // Documented in base class.
571 virtual common::xml::dom::Element
572 asXMLElementInternal (common::xml::dom::Document& document,
573 common::xml::dom::Element& element) const;
574
575 public:
576 // Documented in superclass.
577 const std::string&
578 getXMLNamespace() const;
579 };
580
581 }
582 }
583 }
584
585 #endif // OME_XML_MODEL_SHAPE_H
586
587 /*
588 * Local Variables:
589 * mode:C++
590 * End:
591 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Shape::getLineCap
ome::compat::shared_ptr< ome::xml::model::enums::LineCap > getLineCap()
Get the LineCap property.
Definition: Shape.cpp:653
ome::xml::model::Shape::getTheZ
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getTheZ()
Get the TheZ property.
Definition: Shape.cpp:856
ome::xml::model::Shape::getFontStyle
ome::compat::shared_ptr< ome::xml::model::enums::FontStyle > getFontStyle()
Get the FontStyle property.
Definition: Shape.cpp:716
ome::xml::model::Shape::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Shape.cpp:1139
ome::xml::model::Shape::setLocked
void setLocked(ome::compat::shared_ptr< bool > &locked)
Set the Locked property.
Definition: Shape.cpp:604
ome::xml::model::Shape::setUnion
void setUnion(ome::compat::weak_ptr< ome::xml::model::Union > &union_BackReference)
Set the Union property.
Definition: Shape.cpp:920
ome::xml::model::Shape::setTheC
void setTheC(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &theC)
Set the TheC property.
Definition: Shape.cpp:688
ome::xml::model::Shape::getTransform
ome::compat::shared_ptr< ome::xml::model::AffineTransform > getTransform()
Get the Transform property.
Definition: Shape.cpp:885
ome::xml::model::Shape::setFontFamily
void setFontFamily(ome::compat::shared_ptr< ome::xml::model::enums::FontFamily > &fontFamily)
Set the FontFamily property.
Definition: Shape.cpp:709
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Shape::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: Shape.cpp:289
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Shape::getStrokeWidth
ome::compat::shared_ptr< double > getStrokeWidth()
Get the StrokeWidth property.
Definition: Shape.cpp:569
ome::xml::model::Shape::setID
void setID(const std::string &id)
Set the ID property.
Definition: Shape.cpp:849
ome::xml::model::Shape::getTheC
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getTheC()
Get the TheC property.
Definition: Shape.cpp:674
ome::xml::model::Shape::setTransform
void setTransform(ome::compat::shared_ptr< ome::xml::model::AffineTransform > &transform)
Set the Transform property.
Definition: Shape.cpp:899
ome::xml::model::Shape::setVisible
void setVisible(ome::compat::shared_ptr< bool > &visible)
Set the Visible property.
Definition: Shape.cpp:646
ome::xml::model::Shape::setStrokeColor
void setStrokeColor(ome::compat::shared_ptr< ome::xml::model::primitives::Color > &strokeColor)
Set the StrokeColor property.
Definition: Shape.cpp:814
ome::xml::model::Shape::setFontSize
void setFontSize(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &fontSize)
Set the FontSize property.
Definition: Shape.cpp:751
ome::xml::model::Shape::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: Shape.cpp:533
ome::xml::model::Shape::getFillRule
ome::compat::shared_ptr< ome::xml::model::enums::FillRule > getFillRule()
Get the FillRule property.
Definition: Shape.cpp:611
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Shape::getStrokeDashArray
ome::compat::shared_ptr< std::string > getStrokeDashArray()
Get the StrokeDashArray property.
Definition: Shape.cpp:548
ome::xml::model::Shape::getFillColor
ome::compat::shared_ptr< ome::xml::model::primitives::Color > getFillColor()
Get the FillColor property.
Definition: Shape.cpp:758
ome::xml::model::Shape::setStrokeDashArray
void setStrokeDashArray(ome::compat::shared_ptr< std::string > &strokeDashArray)
Set the StrokeDashArray property.
Definition: Shape.cpp:562
ome::xml::model::Shape::getFontSize
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getFontSize()
Get the FontSize property.
Definition: Shape.cpp:737
ome::xml::model::Shape::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Shape.h:88
ome::xml::model::Shape::setText
void setText(ome::compat::shared_ptr< std::string > &text)
Set the Text property.
Definition: Shape.cpp:793
ome::xml::model::Shape::setTheT
void setTheT(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &theT)
Set the TheT property.
Definition: Shape.cpp:835
ome::xml::transform
void transform(const std::string &target_schema, const Input &input, Output &output, ome::common::xml::EntityResolver &entity_resolver, OMETransformResolver &transform_resolver)
Transform OME-XML to a different model schema version.
Definition: OMETransform.h:99
ome::xml::model::Shape::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: Shape.cpp:927
ome::xml::model::Shape::setFontStyle
void setFontStyle(ome::compat::shared_ptr< ome::xml::model::enums::FontStyle > &fontStyle)
Set the FontStyle property.
Definition: Shape.cpp:730
ome::xml::model::Shape::getVisible
ome::compat::shared_ptr< bool > getVisible()
Get the Visible property.
Definition: Shape.cpp:632
ome::xml::model::Shape::getLocked
ome::compat::shared_ptr< bool > getLocked()
Get the Locked property.
Definition: Shape.cpp:590
ome::xml::model::Shape::setLineCap
void setLineCap(ome::compat::shared_ptr< ome::xml::model::enums::LineCap > &lineCap)
Set the LineCap property.
Definition: Shape.cpp:667
ome::xml::model::Shape
Shape model object.
Definition: Shape.h:85
ome::xml::model::Shape::Shape
Shape()
Default constructor.
Definition: Shape.cpp:255
ome::xml::model::Shape::setTheZ
void setTheZ(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &theZ)
Set the TheZ property.
Definition: Shape.cpp:870
ome::xml::model::Shape::Impl
Private implementation details of Shape model object.
Definition: Shape.cpp:88
ome::xml::model::Shape::setStrokeWidth
void setStrokeWidth(ome::compat::shared_ptr< double > &strokeWidth)
Set the StrokeWidth property.
Definition: Shape.cpp:583
ome::xml::model::Shape::getTheT
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getTheT()
Get the TheT property.
Definition: Shape.cpp:821
ome::xml::model::Shape::~Shape
virtual ~Shape()
Destructor.
Definition: Shape.cpp:274
ome::xml::model::Shape::getText
ome::compat::shared_ptr< std::string > getText()
Get the Text property.
Definition: Shape.cpp:779
ome::xml::model::Shape::getUnion
ome::compat::weak_ptr< ome::xml::model::Union > getUnion()
Get the Union property.
Definition: Shape.cpp:906
ome::xml::model::Shape::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Shape.cpp:280
ome::xml::model::Shape::setFillRule
void setFillRule(ome::compat::shared_ptr< ome::xml::model::enums::FillRule > &fillRule)
Set the FillRule property.
Definition: Shape.cpp:625
ome::xml::model::Shape::getID
const std::string & getID() const
Get the ID property.
Definition: Shape.cpp:842
log.h
ome::xml::model::Shape::getFontFamily
ome::compat::shared_ptr< ome::xml::model::enums::FontFamily > getFontFamily()
Get the FontFamily property.
Definition: Shape.cpp:695
ome::xml::model::Shape::getShapeType
virtual const std::string & getShapeType() const =0
Get the Shape type.
ome::xml::model::Shape::getStrokeColor
ome::compat::shared_ptr< ome::xml::model::primitives::Color > getStrokeColor()
Get the StrokeColor property.
Definition: Shape.cpp:800
ome::xml::model::Shape::setFillColor
void setFillColor(ome::compat::shared_ptr< ome::xml::model::primitives::Color > &fillColor)
Set the FillColor property.
Definition: Shape.cpp:772