ome-xml
5.5.1
ome
xml
model
CommentAnnotation.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_COMMENTANNOTATION_H
47
#define OME_XML_MODEL_COMMENTANNOTATION_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
61
#include <ome/xml/model/primitives/Quantity.h>
62
63
#include <ome/xml/model/StructuredAnnotations.h>
64
#include <ome/xml/model/TextAnnotation.h>
65
66
namespace
ome
67
{
68
namespace
xml
69
{
70
namespace
model
71
{
72
73
// Forward declarations.
74
class
OMEModel;
75
79
class
CommentAnnotation
:
public
TextAnnotation
80
{
81
private
:
82
class
Impl
;
84
std::shared_ptr<Impl>
impl
;
85
86
public
:
88
CommentAnnotation
();
89
95
CommentAnnotation
(
const
CommentAnnotation
& copy);
96
98
virtual
99
~CommentAnnotation
();
100
115
static
std::shared_ptr<CommentAnnotation>
116
create
(
const
common::xml::dom::Element
& element,
117
ome::xml::model::OMEModel
& model);
118
119
// Documented in superclass.
120
const
std::string&
121
elementName
()
const
;
122
123
// Documented in superclass.
124
bool
125
validElementName
(
const
std::string& name)
const
;
126
127
private
:
129
CommentAnnotation
&
130
operator=
(
const
CommentAnnotation
&);
131
132
public
:
133
// -- OMEModelObject API methods --
134
136
virtual
void
137
update
(
const
common::xml::dom::Element
& element,
138
ome::xml::model::OMEModel
& model);
139
140
public
:
141
// -- CommentAnnotation API methods --
142
144
bool
145
link
(std::shared_ptr<Reference>& reference,
146
std::shared_ptr<ome::xml::model::OMEModelObject>&
object
);
147
153
const
std::string&
154
getValue
()
const
;
155
161
void
162
setValue
(
const
std::string& value);
163
169
std::weak_ptr<ome::xml::model::StructuredAnnotations>
170
getStructuredAnnotations
();
171
177
const
std::weak_ptr<ome::xml::model::StructuredAnnotations>
178
getStructuredAnnotations
()
const
;
179
185
void
186
setStructuredAnnotations
(std::weak_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations_BackReference);
187
188
protected
:
189
// Documented in base class.
190
virtual
void
191
asXMLElementInternal
(
common::xml::dom::Document
& document,
192
common::xml::dom::Element
& element)
const
;
193
194
public
:
195
// Documented in superclass.
196
const
std::string&
197
getXMLNamespace
()
const
;
198
};
199
200
}
201
}
202
}
203
204
#endif // OME_XML_MODEL_COMMENTANNOTATION_H
205
206
/*
207
* Local Variables:
208
* mode:C++
209
* End:
210
*/
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition:
OMEModel.h:61
ome::xml::model::CommentAnnotation::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition:
CommentAnnotation.cpp:263
ome::xml::model::CommentAnnotation::CommentAnnotation
CommentAnnotation()
Default constructor.
Definition:
CommentAnnotation.cpp:117
ome::xml::model::CommentAnnotation::operator=
CommentAnnotation & operator=(const CommentAnnotation &)
Assignment operator (deleted).
ome::xml::model::TextAnnotation
TextAnnotation model object.
Definition:
TextAnnotation.h:78
ome::xml::model::CommentAnnotation::setValue
void setValue(const std::string &value)
Set the Value property.
Definition:
CommentAnnotation.cpp:209
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::CommentAnnotation
CommentAnnotation model object.
Definition:
CommentAnnotation.h:79
ome::xml::model::CommentAnnotation::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:
CommentAnnotation.cpp:159
ome::xml::model::CommentAnnotation::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition:
CommentAnnotation.cpp:153
ome::xml::model::CommentAnnotation::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition:
CommentAnnotation.cpp:146
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::CommentAnnotation::getStructuredAnnotations
std::weak_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition:
CommentAnnotation.cpp:216
ome::xml::model::CommentAnnotation::setStructuredAnnotations
void setStructuredAnnotations(std::weak_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations_BackReference)
Set the StructuredAnnotations property.
Definition:
CommentAnnotation.cpp:230
ome::xml::model::CommentAnnotation::create
static std::shared_ptr< CommentAnnotation > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a CommentAnnotation model object from DOM element.
Definition:
CommentAnnotation.cpp:137
ome::xml::model::CommentAnnotation::link
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:
CommentAnnotation.cpp:187
ome::xml::model::CommentAnnotation::~CommentAnnotation
virtual ~CommentAnnotation()
Destructor.
Definition:
CommentAnnotation.cpp:132
ome::xml::model::CommentAnnotation::Impl
Private implementation details of CommentAnnotation model object.
Definition:
CommentAnnotation.cpp:71
ome::xml::model::CommentAnnotation::getValue
const std::string & getValue() const
Get the Value property.
Definition:
CommentAnnotation.cpp:202
ome::xml::model::CommentAnnotation::asXMLElementInternal
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:
CommentAnnotation.cpp:236
log.h
ome::xml::model::CommentAnnotation::impl
std::shared_ptr< Impl > impl
Private implementation details.
Definition:
CommentAnnotation.h:82
Generated on Mon Feb 20 2017 10:34:54 for ome-xml by
1.8.13