te::xsd::AppInfo Class Reference

This class models an object that specifies information to be used by applications. More...

#include <AppInfo.h>

Inheritance diagram for te::xsd::AppInfo:
te::xsd::AnnotationItem

Public Member Functions

 AppInfo (std::string *source, std::string *value)
 Constructor. More...
 
 AppInfo (const AppInfo &rhs)
 Copy constructor. More...
 
AnnotationItemclone () const
 It creates a clone of the annotation item. More...
 
std::string * getSource () const
 It returns the URI that specifies the source of the information. More...
 
std::string * getValue () const
 It returns the information associated to the annotation. More...
 
AppInfooperator= (const AppInfo &rhs)
 Assignment operator. More...
 
void setSource (std::string *source)
 It sets the URI that specifies the source of the information. More...
 
void setValue (std::string *value)
 It sets the information to be used by the application. More...
 
 ~AppInfo ()
 Destructor. More...
 

Private Attributes

std::string * m_source
 An URI that specifies the source of the application information. (Optional) More...
 
std::string * m_value
 An information to be used by the application. (Required) More...
 

Detailed Description

This class models an object that specifies information to be used by applications.

See also
Annotation, AnnotationItem, Documentation
Note
Parent element: Annotation.

Definition at line 48 of file AppInfo.h.

Constructor & Destructor Documentation

te::xsd::AppInfo::AppInfo ( std::string *  source,
std::string *  value 
)

Constructor.

Parameters
sourceA URI reference that specifies the source of the application information.
valueAny descriptive information.
Note
The AppInfo object will take the ownership of the source and value pointers.
te::xsd::AppInfo::AppInfo ( const AppInfo rhs)

Copy constructor.

Parameters
rhsRight-hand-side object.
te::xsd::AppInfo::~AppInfo ( )

Destructor.

Member Function Documentation

AnnotationItem* te::xsd::AppInfo::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::AppInfo::getSource ( ) const

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

Returns
The URI.
std::string* te::xsd::AppInfo::getValue ( ) const

It returns the information associated to the annotation.

Returns
The information associated to the annotation.
AppInfo& te::xsd::AppInfo::operator= ( const AppInfo rhs)

Assignment operator.

Parameters
rhsRight-hand-side object.
Returns
A reference to this object.
void te::xsd::AppInfo::setSource ( std::string *  source)

It sets the URI that specifies the source of the information.

Parameters
infoAn URI.
void te::xsd::AppInfo::setValue ( std::string *  value)

It sets the information to be used by the application.

Parameters
valueA machine readable material.
Note
The AppInfo object will take the ownership of the given pointer.

Member Data Documentation

std::string* te::xsd::AppInfo::m_source
private

An URI that specifies the source of the application information. (Optional)

Definition at line 115 of file AppInfo.h.

std::string* te::xsd::AppInfo::m_value
private

An information to be used by the application. (Required)

Definition at line 116 of file AppInfo.h.


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