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 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 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 removeRule (std::size_t i)
 
void removeRules ()
 
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

◆ ReturnType

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

Definition at line 58 of file BaseVisitable.h.

◆ VisitorType

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

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

◆ Style()

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

It initializes a new Style.

◆ ~Style()

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

Virtual destructor.

Member Function Documentation

◆ accept()

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.

◆ clone()

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.

◆ getDescription()

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

◆ getName()

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

◆ getOnlineResource()

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

◆ getOnlineResources()

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

◆ getRule()

Rule* te::se::Style::getRule ( std::size_t  i) const

◆ getRules()

const std::vector<Rule*>& te::se::Style::getRules ( ) const

◆ getSemanticTypeIdentifier()

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

◆ getSemanticTypeIdentifiers()

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

◆ getType()

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.

◆ getVersion()

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

◆ push_back() [1/3]

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

◆ push_back() [2/3]

void te::se::Style::push_back ( Rule rule)

◆ push_back() [3/3]

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

◆ removeRule()

void te::se::Style::removeRule ( std::size_t  i)

◆ removeRules()

void te::se::Style::removeRules ( )

◆ setDescription()

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

◆ setName()

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

◆ setVersion()

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

Member Data Documentation

◆ m_description

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

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

Definition at line 138 of file Style.h.

◆ m_name

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 137 of file Style.h.

◆ m_onlineResources

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 141 of file Style.h.

◆ m_rules

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 140 of file Style.h.

◆ m_semanticTypeIdentifiers

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 139 of file Style.h.

◆ m_version

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 142 of file Style.h.


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