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.

te::xsd::Documentation::Documentation

(

const Documentation &

rhs

)

Copy constructor.

Parameters

rhs	Right-hand-side object.

te::xsd::Documentation::~Documentation

(

)

Destructor.

Member Function Documentation

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.

std::string* te::xsd::Documentation::getLang

(

)

const

It returns the language used to code the annotation.

Returns

The language used to code the annotation.

std::string* te::xsd::Documentation::getSource

(

)

const

It returns the URI that specifies the source of the application information.

Returns

The URI.

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

(

)

const

It returns the information associated to the annotation.

Returns

The information associated to the annotation.

Documentation& te::xsd::Documentation::operator=

(

const Documentation &

rhs

)

Assignment operator.

Parameters

rhs	Right-hand-side object.

Returns

A reference to this object.

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.

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.

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.

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.

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.

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

private

A human readable text. (Required)

Definition at line 134 of file Documentation.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/xsd/Documentation.h