te::se::FeatureTypeStyle Class Referenceabstract

The FeatureTypeStyle defines the styling that is to be applied to a dataset that can be viewed as a feature type. More...

#include <FeatureTypeStyle.h>

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

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...
 
Initializer Methods

Methods related to instantiation and destruction.

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

Methods used to get or set properties.

void setFeatureTypeName (std::string *name)
 
const std::string * getFeatureTypeName () const
 
const std::string & getType () const
 It returns the style type. More...
 
Styleclone () const
 It creates a new copy of this object. 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)
 
void push_back (Rule *rule)
 
void push_back (te::xl::SimpleLink *onlineResource)
 
const std::string & getSemanticTypeIdentifier (std::size_t i)
 
const std::vector< std::string > * getSemanticTypeIdentifiers () const
 
const std::vector< Rule * > & getRules () const
 
RulegetRule (std::size_t i) const
 
void removeRule (std::size_t i)
 
void removeRules ()
 
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
 

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...
 

Private Attributes

std::string * m_featureTypeName
 It identifies the specific feature type that the style is for. (Optional) More...
 

Static Private Attributes

static const std::string sm_type
 A static data member used in the implementation of getType method. More...
 

Detailed Description

The FeatureTypeStyle defines the styling that is to be applied to a dataset that can be viewed as a feature type.

See also
Style, CoverageStyle

Definition at line 45 of file FeatureTypeStyle.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

◆ FeatureTypeStyle()

te::se::FeatureTypeStyle::FeatureTypeStyle ( )

It initializes a new FeatureTypeStyle.

◆ ~FeatureTypeStyle()

te::se::FeatureTypeStyle::~FeatureTypeStyle ( )

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()

Style* te::se::FeatureTypeStyle::clone ( ) const
virtual

It creates a new copy of this object.

Implements te::se::Style.

◆ getDescription()

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

◆ getFeatureTypeName()

const std::string* te::se::FeatureTypeStyle::getFeatureTypeName ( ) const

◆ getName()

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

◆ getOnlineResource()

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

◆ getOnlineResources()

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

◆ getRule()

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

◆ getRules()

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

◆ getSemanticTypeIdentifier()

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

◆ getSemanticTypeIdentifiers()

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

◆ getType()

const std::string& te::se::FeatureTypeStyle::getType ( ) const
virtual

It returns the style type.

Returns
The style type.

Implements te::se::Style.

◆ getVersion()

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

◆ push_back() [1/3]

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

◆ push_back() [2/3]

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

◆ push_back() [3/3]

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

◆ removeRule()

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

◆ removeRules()

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

◆ setDescription()

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

◆ setFeatureTypeName()

void te::se::FeatureTypeStyle::setFeatureTypeName ( std::string *  name)

◆ setName()

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

◆ setVersion()

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

Member Data Documentation

◆ m_description

Description* te::se::Style::m_description
protectedinherited

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

Definition at line 138 of file Style.h.

◆ m_featureTypeName

std::string* te::se::FeatureTypeStyle::m_featureTypeName
private

It identifies the specific feature type that the style is for. (Optional)

Definition at line 82 of file FeatureTypeStyle.h.

◆ m_name

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

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
protectedinherited

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
protectedinherited

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
protectedinherited

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
protectedinherited

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.

◆ sm_type

const std::string te::se::FeatureTypeStyle::sm_type
staticprivate

A static data member used in the implementation of getType method.

Definition at line 83 of file FeatureTypeStyle.h.


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