A class that models a documentation element used to enter text comments in annotations. More...
#include <Documentation.h>
Public Member Functions | |
AnnotationItem * | clone () const |
It creates a clone of the annotation item. More... | |
Documentation (std::string *value, std::string *source=0, std::string *lang=0) | |
Constructor. More... | |
Documentation (const Documentation &rhs) | |
Copy constructor. More... | |
std::string * | getLang () const |
It returns the language used to code the annotation. More... | |
std::string * | getSource () const |
It returns the URI that specifies the source of the application information. More... | |
std::string * | getValue () const |
It returns the information associated to the annotation. More... | |
Documentation & | operator= (const Documentation &rhs) |
Assignment operator. More... | |
void | setLang (std::string *lang) |
It sets the language of the information. More... | |
void | setSource (std::string *source) |
It sets the URI reference that specifies the source of the information. More... | |
void | setValue (std::string *doc) |
It sets the information associated to the annotation. More... | |
~Documentation () | |
Destructor. More... | |
Private Attributes | |
std::string * | m_lang |
The language of the information. Example: "en". (Optional) More... | |
std::string * | m_source |
An URI reference that specifies the source of the information. (Optional) More... | |
std::string * | m_value |
A human readable text. (Required) More... | |
A class that models a documentation element used to enter text comments in annotations.
Definition at line 48 of file Documentation.h.
te::xsd::Documentation::Documentation | ( | std::string * | value, |
std::string * | source = 0 , |
||
std::string * | lang = 0 |
||
) |
Constructor.
value | The descriptive information. (Required) |
source | An URI that specifies the source of the information. |
lang | The language of the information. |
Definition at line 29 of file Documentation.cpp.
te::xsd::Documentation::Documentation | ( | const Documentation & | rhs | ) |
Copy constructor.
rhs | Right-hand-side object. |
Definition at line 36 of file Documentation.cpp.
te::xsd::Documentation::~Documentation | ( | ) |
Destructor.
Definition at line 46 of file Documentation.cpp.
|
virtual |
It creates a clone of the annotation item.
Implements te::xsd::AnnotationItem.
Definition at line 106 of file Documentation.cpp.
std::string * te::xsd::Documentation::getLang | ( | ) | const |
It returns the language used to code the annotation.
Definition at line 73 of file Documentation.cpp.
std::string * te::xsd::Documentation::getSource | ( | ) | const |
It returns the URI that specifies the source of the application information.
Definition at line 83 of file Documentation.cpp.
std::string * te::xsd::Documentation::getValue | ( | ) | const |
It returns the information associated to the annotation.
Definition at line 78 of file Documentation.cpp.
te::xsd::Documentation & te::xsd::Documentation::operator= | ( | const Documentation & | rhs | ) |
Assignment operator.
rhs | Right-hand-side object. |
Definition at line 53 of file Documentation.cpp.
void te::xsd::Documentation::setLang | ( | std::string * | lang | ) |
It sets the language of the information.
lang | The language of the information. |
Definition at line 88 of file Documentation.cpp.
Referenced by te::xsd::serialize::ReadAnnotation().
void te::xsd::Documentation::setSource | ( | std::string * | source | ) |
It sets the URI reference that specifies the source of the information.
source | The URI. |
Definition at line 100 of file Documentation.cpp.
Referenced by te::xsd::serialize::ReadAnnotation().
void te::xsd::Documentation::setValue | ( | std::string * | doc | ) |
It sets the information associated to the annotation.
doc | A human readable material. This parameter can not be NULL. |
Definition at line 94 of file Documentation.cpp.
Referenced by te::xsd::serialize::ReadAnnotation().
|
private |
The language of the information. Example: "en". (Optional)
Definition at line 136 of file Documentation.h.
Referenced by Documentation(), and operator=().
|
private |
An URI reference that specifies the source of the information. (Optional)
Definition at line 135 of file Documentation.h.
Referenced by Documentation(), and operator=().
|
private |
A human readable text. (Required)
Definition at line 134 of file Documentation.h.
Referenced by Documentation(), and operator=().