All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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.

Definition at line 29 of file AppInfo.cpp.

te::xsd::AppInfo::AppInfo ( const AppInfo rhs)

Copy constructor.

Parameters
rhsRight-hand-side object.

Definition at line 35 of file AppInfo.cpp.

References m_source, and m_value.

te::xsd::AppInfo::~AppInfo ( )

Destructor.

Definition at line 43 of file AppInfo.cpp.

Member Function Documentation

te::xsd::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.

Definition at line 87 of file AppInfo.cpp.

std::string * te::xsd::AppInfo::getSource ( ) const

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

Returns
The URI.

Definition at line 82 of file AppInfo.cpp.

std::string * te::xsd::AppInfo::getValue ( ) const

It returns the information associated to the annotation.

Returns
The information associated to the annotation.

Definition at line 77 of file AppInfo.cpp.

te::xsd::AppInfo & te::xsd::AppInfo::operator= ( const AppInfo rhs)

Assignment operator.

Parameters
rhsRight-hand-side object.
Returns
A reference to this object.

Definition at line 49 of file AppInfo.cpp.

References m_source, and m_value.

void te::xsd::AppInfo::setSource ( std::string *  source)

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

Parameters
infoAn URI.

Definition at line 71 of file AppInfo.cpp.

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

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.

Definition at line 65 of file AppInfo.cpp.

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

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.

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

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.

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


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