te::xsd::Documentation Class Reference

A class that models a documentation element used to enter text comments in annotations. More...

#include <Documentation.h>

Inheritance diagram for te::xsd::Documentation:

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...

Detailed Description

A class that models a documentation element used to enter text comments in annotations.

See also

Annotation, AnnotationItem, AppInfo

Note

Parent element: Annotation.

Definition at line 48 of file Documentation.h.

Constructor & Destructor Documentation

te::xsd::Documentation::Documentation	(	std::string *	value,
		std::string *	source = 0,
		std::string *	lang = 0
	)

Constructor.

Parameters

value	The descriptive information. (Required)
source	An URI that specifies the source of the information.
lang	The language of the information.

Note

The Documentation object will take the ownership of the pointers source, lang and value.

Definition at line 29 of file Documentation.cpp.

te::xsd::Documentation::Documentation

(

const Documentation &

rhs

)

Copy constructor.

Parameters

rhs	Right-hand-side object.

Definition at line 36 of file Documentation.cpp.

References m_lang, m_source, and m_value.

te::xsd::Documentation::~Documentation

(

)

Destructor.

Definition at line 46 of file Documentation.cpp.

Member Function Documentation

te::xsd::AnnotationItem * te::xsd::Documentation::clone ( ) const

virtual

It creates a clone of the annotation item.

Returns

A clone of the annotation item. The client of this method will take the ownership of the clone.

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.

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.

Returns

The URI.

Definition at line 83 of file Documentation.cpp.

std::string * te::xsd::Documentation::getValue

(

)

const

It returns the information associated to the annotation.

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.

Parameters

rhs	Right-hand-side object.

Returns

A reference to this object.

Definition at line 53 of file Documentation.cpp.

References m_lang, m_source, and m_value.

void te::xsd::Documentation::setLang

(

std::string *

lang

)

It sets the language of the information.

Parameters

lang	The language of the information.

Note

The Documentation object will take the ownership of the given pointer.

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.

Parameters

source

The URI.

Note

The Documentation object will take the ownership of the given pointer.

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.

Parameters

doc	A human readable material. This parameter can not be NULL.

Note

The Documentation object will take the ownership of the given pointer.

Definition at line 94 of file Documentation.cpp.

Referenced by te::xsd::serialize::ReadAnnotation().

Member Data Documentation

std::string* te::xsd::Documentation::m_lang

private

The language of the information. Example: "en". (Optional)

Definition at line 136 of file Documentation.h.

Referenced by Documentation(), and operator=().

std::string* te::xsd::Documentation::m_source

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=().

std::string* te::xsd::Documentation::m_value

private

A human readable text. (Required)

Definition at line 134 of file Documentation.h.

Referenced by Documentation(), and operator=().

---

The documentation for this class was generated from the following files:

• C:/BB_TL5/terralib5/src/terralib/xsd/Documentation.h
• C:/BB_TL5/terralib5/src/terralib/xsd/Documentation.cpp