te::se::CoverageStyle Class Referenceabstract

The CoverageStyle defines the styling that is to be applied to a subset of Coverage data. More...

#include <CoverageStyle.h>

Inheritance diagram for te::se::CoverageStyle:
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...
 
Styleclone () const
 It creates a new copy of this object. More...
 
Initializer Methods

Methods related to instantiation and destruction.

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

Methods used to get or set properties.

void setCoverageName (std::string *name)
 
const std::string * getCoverageName () const
 
const std::string & getType () const
 It returns the style type. 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
 
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_coverageName
 It identifies the specific coverage that the coverage 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 CoverageStyle defines the styling that is to be applied to a subset of Coverage data.

See also
Style, FeatureTypeStyle

Definition at line 45 of file CoverageStyle.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::CoverageStyle::CoverageStyle ( )

It initializes a new CoverageStyle.

te::se::CoverageStyle::~CoverageStyle ( )

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.
Style* te::se::CoverageStyle::clone ( ) const
virtual

It creates a new copy of this object.

Implements te::se::Style.

const std::string* te::se::CoverageStyle::getCoverageName ( ) const
const Description* te::se::Style::getDescription ( ) const
inherited
const std::string* te::se::Style::getName ( ) const
inherited
const te::xl::SimpleLink* te::se::Style::getOnlineResource ( std::size_t  i) const
inherited
const std::vector<te::xl::SimpleLink*>& te::se::Style::getOnlineResources ( ) const
inherited
Rule* te::se::Style::getRule ( std::size_t  i) const
inherited
const std::vector<Rule*>& te::se::Style::getRules ( ) const
inherited
const std::string& te::se::Style::getSemanticTypeIdentifier ( std::size_t  i)
inherited
const std::vector<std::string>* te::se::Style::getSemanticTypeIdentifiers ( ) const
inherited
const std::string& te::se::CoverageStyle::getType ( ) const
virtual

It returns the style type.

Returns
The style type.

Implements te::se::Style.

const std::string& te::se::Style::getVersion ( ) const
inherited
void te::se::Style::push_back ( const std::string &  semanticTypeIdentifier)
inherited
void te::se::Style::push_back ( Rule rule)
inherited
void te::se::Style::push_back ( te::xl::SimpleLink onlineResource)
inherited
void te::se::CoverageStyle::setCoverageName ( std::string *  name)
void te::se::Style::setDescription ( Description d)
inherited
void te::se::Style::setName ( std::string *  name)
inherited
void te::se::Style::setVersion ( const std::string &  v)
inherited

Member Data Documentation

std::string* te::se::CoverageStyle::m_coverageName
private

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

Definition at line 82 of file CoverageStyle.h.

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

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

Definition at line 134 of file Style.h.

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

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

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

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

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

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

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

Definition at line 83 of file CoverageStyle.h.


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