te::se::Symbolizer Class Referenceabstract

A Symbolizer describes how a feature is to appear on a map. More...

#include <Symbolizer.h>

Inheritance diagram for te::se::Symbolizer:
te::common::BaseVisitable< Visitor > te::se::LineSymbolizer te::se::PointSymbolizer te::se::PolygonSymbolizer te::se::RasterSymbolizer te::se::TextSymbolizer

Public Types

typedef void 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 Symbolizerclone () const =0
 It creates a new copy of this object. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 Symbolizer ()
 It initializes a new Symbolizer. More...
 
 Symbolizer (const Symbolizer &rhs)
 Copy constructor. More...
 
virtual ~Symbolizer ()
 Virtual destructor. More...
 
Accessor methods

Methods used to get or set properties.

void setName (const std::string &name)
 
const std::string & getName () const
 
void setDescription (Description *d)
 
const DescriptiongetDescription () const
 
void setBaseSymbolizer (te::xl::SimpleLink *baseSymbolizer)
 
const te::xl::SimpleLinkgetBaseSymbolizer () const
 
void setVersion (const std::string &version)
 
const std::string & getVersion () const
 
void setUom (const te::common::BaseUnitOfMeasure *uom)
 It sets the unit-of-measure. More...
 
const te::common::BaseUnitOfMeasure * getUom () const
 
virtual const std::string & getType () const =0
 It returns the symbolizer type. More...
 

Private Attributes

te::xl::SimpleLinkm_baseSymbolizer
 A BaseSymbolizer (an OnlineResource) defines the default properties of a Symbolizer to be those of an external Symbolizer, which will frequently be inside of an OGC Symbolizer repository. The Symbolizer properties given in-line override the base-Symbolizer properties. (Optional) More...
 
Descriptionm_description
 It gives the familiar short title for display lists and longer description for the symbolizer. (Optional) More...
 
std::string m_name
 It allows the symbolizer to be referenced externally, which is needed in some methods of SE usage. (Optional) More...
 
const te::common::BaseUnitOfMeasure * m_uom
 Unit of measurement. If no uom is set inside of Symbolizer, all units are measured in pixel. (Mandatory) More...
 
std::string m_version
 The version is an optional attribute on the FeatureType Style element that identifies the SE version number that the FeatureTypeStyle corresponds to. For now, the only allowed value is 1.1.0. (Mandatory) More...
 

Detailed Description

A Symbolizer describes how a feature is to appear on a map.

A Symbolizer is an abstract type for encoding the graphical properties used to portray geographic information. Concrete Symbolizers are derived from this base type. A Symbolizer describes how a feature is to appear on a map. The Symbolizer describes not just the shape that should appear but also such graphical properties as color and opacity. A Symbolizer is obtained by specifying one of a small number of different types of Symbolizers and then supplying parameters to override its default behaviour. Five types of Symbolizers are defined:

  1. Line
  2. Polygon
  3. Point
  4. Text
  5. Raster

Concrete Symbolizer types are derived from this base type.

See also
Rule, LineSymbolizer, PointSymbolizer, PolygonSymbolizer, TextSymbolizer, RasterSymbolizer, Description

Definition at line 80 of file Symbolizer.h.

Member Typedef Documentation

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

Definition at line 58 of file BaseVisitable.h.

typedef Visitor te::common::BaseVisitable< Visitor , void >::VisitorType
inherited

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

te::se::Symbolizer::Symbolizer ( )

It initializes a new Symbolizer.

te::se::Symbolizer::Symbolizer ( const Symbolizer rhs)

Copy constructor.

Parameters
rhsThe other symbolizer.
virtual te::se::Symbolizer::~Symbolizer ( )
virtual

Virtual destructor.

Member Function Documentation

virtual ReturnType te::common::BaseVisitable< Visitor , void >::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 Symbolizer* te::se::Symbolizer::clone ( ) const
pure virtual
const te::xl::SimpleLink* te::se::Symbolizer::getBaseSymbolizer ( ) const
const Description* te::se::Symbolizer::getDescription ( ) const
const std::string& te::se::Symbolizer::getName ( ) const
virtual const std::string& te::se::Symbolizer::getType ( ) const
pure virtual

It returns the symbolizer type.

Returns
The symbolizer type.

Implemented in te::se::PolygonSymbolizer, te::se::RasterSymbolizer, te::se::LineSymbolizer, te::se::TextSymbolizer, and te::se::PointSymbolizer.

const te::common::BaseUnitOfMeasure* te::se::Symbolizer::getUom ( ) const
const std::string& te::se::Symbolizer::getVersion ( ) const
void te::se::Symbolizer::setBaseSymbolizer ( te::xl::SimpleLink baseSymbolizer)
void te::se::Symbolizer::setDescription ( Description d)
void te::se::Symbolizer::setName ( const std::string &  name)
void te::se::Symbolizer::setUom ( const te::common::BaseUnitOfMeasure *  uom)

It sets the unit-of-measure.

All Symbolizers include an optional gml:uom-attribute as used by GML (this is set inside the abstract SymbolizerType and therefore inherited by all Symbolizers). This applies to all elements included inside a Symbolizer such as stroke-width, size, font-size, Gap, InitialGap, Displacement and PerpendicularOffset. If no uom is set inside of Symbolizer, all units are measured in pixel, the behaviour used by SLD 1.0.0. The following uom definitions are recommended to be used:

void te::se::Symbolizer::setVersion ( const std::string &  version)

Member Data Documentation

te::xl::SimpleLink* te::se::Symbolizer::m_baseSymbolizer
private

A BaseSymbolizer (an OnlineResource) defines the default properties of a Symbolizer to be those of an external Symbolizer, which will frequently be inside of an OGC Symbolizer repository. The Symbolizer properties given in-line override the base-Symbolizer properties. (Optional)

Definition at line 164 of file Symbolizer.h.

Description* te::se::Symbolizer::m_description
private

It gives the familiar short title for display lists and longer description for the symbolizer. (Optional)

Definition at line 163 of file Symbolizer.h.

std::string te::se::Symbolizer::m_name
private

It allows the symbolizer to be referenced externally, which is needed in some methods of SE usage. (Optional)

Definition at line 162 of file Symbolizer.h.

const te::common::BaseUnitOfMeasure* te::se::Symbolizer::m_uom
private

Unit of measurement. If no uom is set inside of Symbolizer, all units are measured in pixel. (Mandatory)

Definition at line 166 of file Symbolizer.h.

std::string te::se::Symbolizer::m_version
private

The version is an optional attribute on the FeatureType Style element that identifies the SE version number that the FeatureTypeStyle corresponds to. For now, the only allowed value is 1.1.0. (Mandatory)

Definition at line 165 of file Symbolizer.h.


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