All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
te::se::Style Class Referenceabstract

The Style defines the styling that is to be applied to a geographic dataset (vector geometries or coverage). More...

#include <Style.h>

Inheritance diagram for te::se::Style:
te::common::BaseVisitable< Visitor > te::se::CoverageStyle te::se::FeatureTypeStyle

Public Types

typedef R ReturnType
 
typedef Visitor VisitorType
 

Public Member Functions

virtual ReturnType accept (VisitorType &guest) const =0
 It call the visit method from the guest object. More...
 
virtual Styleclone () const =0
 It creates a new copy of this object. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 Style ()
 It initializes a new Style. More...
 
virtual ~Style ()
 Virtual destructor. More...
 
Accessor methods

Methods used to get or set properties.

void setName (std::string *name)
 
const std::string * getName () const
 
void setDescription (Description *d)
 
const DescriptiongetDescription () const
 
void push_back (const std::string &semanticTypeIdentifier)
 
const std::string & getSemanticTypeIdentifier (std::size_t i)
 
const std::vector< std::string > * getSemanticTypeIdentifiers () const
 
void push_back (Rule *rule)
 
const std::vector< Rule * > & getRules () const
 
RulegetRule (std::size_t i) const
 
void push_back (te::xl::SimpleLink *onlineResource)
 
const std::vector
< te::xl::SimpleLink * > & 
getOnlineResources () const
 
const te::xl::SimpleLinkgetOnlineResource (std::size_t i) const
 
void setVersion (const std::string &v)
 
const std::string & getVersion () const
 
virtual const std::string & getType () const =0
 It returns the style type. More...
 

Protected Attributes

Descriptionm_description
 It gives an informative description of the style. (Optional) More...
 
std::string * m_name
 It allows the style to be referenced. Names must be unique in the context in which they are defined. (Optional) More...
 
std::vector< te::xl::SimpleLink * > m_onlineResources
 It refers to an external document. (Mandatory if m_rules is empty, otherwise, it is optional) More...
 
std::vector< Rule * > m_rules
 It allows conditional rendering. (Mandatory if m_onlineResource is empty, otherwise, it is optional) More...
 
std::vector< std::string > * m_semanticTypeIdentifiers
 The SemanticTypeIdentifier is experimental and is intended to be used to identify what the feature style is suitable to be used for using community-controlled name(s). (Optional) More...
 
std::string m_version
 The version is an optional attribute on the FeatureTypeStyle that identifies the SE version number that the FeatureTypeStyle corresponds to. (Optional) More...
 

Detailed Description

The Style defines the styling that is to be applied to a geographic dataset (vector geometries or coverage).

The ordering to use for the Rules inside of a Style is following the "painters model" with the first item in a list being the first item plotted and hence being on the "bottom".

See also
FeatureTypeStyle, CoverageStyle, Description, Rule

Definition at line 65 of file Style.h.

Member Typedef Documentation

typedef R te::common::BaseVisitable< Visitor , R >::ReturnType
inherited

Definition at line 58 of file BaseVisitable.h.

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

te::se::Style::Style ( )

It initializes a new Style.

Definition at line 36 of file Style.cpp.

te::se::Style::~Style ( )
virtual

Virtual destructor.

Definition at line 44 of file Style.cpp.

References te::common::FreeContents().

Member Function Documentation

virtual ReturnType te::common::BaseVisitable< Visitor , R >::accept ( VisitorType guest) const
pure virtualinherited

It call the visit method from the guest object.

Parameters
guestThe guest or visitor.
Returns
Any valid value define by the template type R.
virtual Style* te::se::Style::clone ( ) const
pure virtual

It creates a new copy of this object.

Implemented in te::se::CoverageStyle, and te::se::FeatureTypeStyle.

Referenced by te::qt::plugins::terralib4::TL4ConverterWizard::finish().

const te::se::Description * te::se::Style::getDescription ( ) const

Definition at line 70 of file Style.cpp.

Referenced by CoverageStyleWriter(), and FeatureTypeStyleWriter().

const std::string * te::se::Style::getName ( ) const

Definition at line 59 of file Style.cpp.

Referenced by CoverageStyleWriter(), and FeatureTypeStyleWriter().

const te::xl::SimpleLink * te::se::Style::getOnlineResource ( std::size_t  i) const

Definition at line 122 of file Style.cpp.

Referenced by CoverageStyleWriter(), and FeatureTypeStyleWriter().

const std::vector< te::xl::SimpleLink * > & te::se::Style::getOnlineResources ( ) const

Definition at line 117 of file Style.cpp.

Referenced by CoverageStyleWriter(), and FeatureTypeStyleWriter().

const std::string & te::se::Style::getSemanticTypeIdentifier ( std::size_t  i)

Definition at line 83 of file Style.cpp.

const std::vector< std::string > * te::se::Style::getSemanticTypeIdentifiers ( ) const

Definition at line 89 of file Style.cpp.

Referenced by CoverageStyleWriter(), and FeatureTypeStyleWriter().

virtual const std::string& te::se::Style::getType ( ) const
pure virtual

It returns the style type.

Returns
The style type.

Implemented in te::se::CoverageStyle, and te::se::FeatureTypeStyle.

Referenced by te::se::serialize::Style::write().

const std::string & te::se::Style::getVersion ( ) const

Definition at line 133 of file Style.cpp.

Referenced by CoverageStyleWriter(), and FeatureTypeStyleWriter().

void te::se::Style::push_back ( const std::string &  semanticTypeIdentifier)
void te::se::Style::push_back ( Rule rule)

Definition at line 99 of file Style.cpp.

void te::se::Style::push_back ( te::xl::SimpleLink onlineResource)

Definition at line 111 of file Style.cpp.

void te::se::Style::setDescription ( Description d)

Definition at line 64 of file Style.cpp.

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

void te::se::Style::setName ( std::string *  name)

Definition at line 53 of file Style.cpp.

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

void te::se::Style::setVersion ( const std::string &  v)

Definition at line 128 of file Style.cpp.

Member Data Documentation

Description* te::se::Style::m_description
protected

It gives an informative description of the style. (Optional)

Definition at line 134 of file Style.h.

std::string* te::se::Style::m_name
protected

It allows the style to be referenced. Names must be unique in the context in which they are defined. (Optional)

Definition at line 133 of file Style.h.

Referenced by te::qt::plugins::terralib4::TL4ConverterWizard::finish().

std::vector<te::xl::SimpleLink*> te::se::Style::m_onlineResources
protected

It refers to an external document. (Mandatory if m_rules is empty, otherwise, it is optional)

Definition at line 137 of file Style.h.

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

std::vector<Rule*> te::se::Style::m_rules
protected

It allows conditional rendering. (Mandatory if m_onlineResource is empty, otherwise, it is optional)

Definition at line 136 of file Style.h.

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

std::vector<std::string>* te::se::Style::m_semanticTypeIdentifiers
protected

The SemanticTypeIdentifier is experimental and is intended to be used to identify what the feature style is suitable to be used for using community-controlled name(s). (Optional)

Definition at line 135 of file Style.h.

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

std::string te::se::Style::m_version
protected

The version is an optional attribute on the FeatureTypeStyle that identifies the SE version number that the FeatureTypeStyle corresponds to. (Optional)

Definition at line 138 of file Style.h.

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


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