Public Member Functions | Private Attributes | List of all members
te::se::Description Class Reference
Symbology Encoding

A Description gives human-readable descriptive information for the object it is included within. More...

#include <Description.h>

Inheritance diagram for te::se::Description:

Public Member Functions

Description * clone () const
 It creates a new copy of this object. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 Description ()
 It initializes a new Description. More...
 
 ~Description ()
 Destructor. More...
 
Accessor methods

Methods used to get or set properties.

void setTitle (const std::string &title)
 
const std::string & getTitle () const
 
void setAbstract (const std::string &a)
 
const std::string & getAbstract () const
 

Private Attributes

std::string m_abstract
 Abstract. (Optional) More...
 
std::string m_title
 Title. (Optional) More...
 

Detailed Description

A Description gives human-readable descriptive information for the object it is included within.

This information can be extracted and used for such purposes as creating informal searchable metadata in catalogue systems. More metadata fields may be added to this element in the future.

See also
Symbolizer, CoverageStyle, Rule, FeatureTypeStyle, CoverageStyle

Definition at line 56 of file Description.h.

Constructor & Destructor Documentation

te::se::Description::Description ( )
default

It initializes a new Description.

Referenced by clone().

te::se::Description::~Description ( )
default

Destructor.

Member Function Documentation

te::se::Description * te::se::Description::clone ( ) const

It creates a new copy of this object.

Definition at line 53 of file Description.cpp.

References d, Description(), m_abstract, m_title, setAbstract(), and setTitle().

Referenced by te::se::FeatureTypeStyle::clone(), te::se::CoverageStyle::clone(), te::se::Rule::clone(), and te::se::Symbolizer::Symbolizer().

const std::string & te::se::Description::getAbstract ( ) const

Definition at line 48 of file Description.cpp.

References m_abstract.

Referenced by te::se::serialize::Save().

const std::string & te::se::Description::getTitle ( ) const

Definition at line 38 of file Description.cpp.

References m_title.

Referenced by te::qt::widgets::StyleItem::getToolTip(), te::qt::widgets::RuleItem::getToolTip(), te::qt::widgets::LegendItem::LegendItem(), and te::se::serialize::Save().

void te::se::Description::setAbstract ( const std::string &  a)

Definition at line 43 of file Description.cpp.

References m_abstract.

Referenced by clone(), and te::se::CreateDescription().

void te::se::Description::setTitle ( const std::string &  title)

Definition at line 33 of file Description.cpp.

References m_title.

Referenced by clone(), te::se::CreateDescription(), te::qt::plugins::terralib4::GetGrouping(), and te::qt::widgets::GroupingWidget::updateStyle().

Member Data Documentation

std::string te::se::Description::m_abstract
private

Abstract. (Optional)

Definition at line 94 of file Description.h.

Referenced by clone(), getAbstract(), and setAbstract().

std::string te::se::Description::m_title
private

Title. (Optional)

Definition at line 93 of file Description.h.

Referenced by clone(), getTitle(), and setTitle().

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