te::color::ColorSchemeCatalog Class Reference

A catalog for color schemes. More...

#include <ColorSchemeCatalog.h>

Public Member Functions

Initializer Methods

Methods related to instantiation and destruction.

 ColorSchemeCatalog (const std::string &name)
 It initializes a new ColorSchemeCatalog. More...
 
 ~ColorSchemeCatalog ()
 Destructor. More...
 
Accessor methods

Methods used to get or set properties.

const std::string & getName () const
 It returns the catalog name. More...
 
void setName (const std::string &newName)
 It changes the catalog name and adjusts its entry in the catalog manager if needed. More...
 
const std::string & getDescription () const
 It returns the catalog description. More...
 
void setDescription (const std::string &d)
 It sets the catalog description. More...
 
const std::string & getAuthor () const
 It returns the catalog author name. More...
 
void setAuthor (const std::string &author)
 It sets the catalog author name. More...
 
const std::string & getCopyright () const
 It returns the catalog copyright notice. More...
 
void setCopyright (const std::string &c)
 It sets the catalog copyright notice. More...
 
const std::string & getOnlineResource () const
 It returns a link for more information about the catalog. More...
 
void setOnlineResource (const std::string &r)
 It sets the link for more information about the catalog. More...
 
void push_back (ColorSchemeGroup *group)
 It adds a new group to the catalog and sets its relationship. More...
 
void disconnect (ColorSchemeGroup *group)
 It removes the internal reference to the group. More...
 
const std::vector< ColorSchemeGroup * > & getColorSchemeGroups () const
 It returns the list of color scheme groups in the catalog. More...
 

Private Member Functions

Copy Constructor and Assignment Operator

Copy constructor and assignment operator not allowed.

 ColorSchemeCatalog (const ColorSchemeCatalog &rhs)
 Copy constructor not allowed. More...
 
ColorSchemeCatalogoperator= (const ColorSchemeCatalog &rhs)
 Assignment operator not allowed. More...
 

Private Attributes

std::string m_author
 Information about catalog author. More...
 
std::vector< ColorSchemeGroup * > m_colorSchemeGroups
 The color scheme groups. More...
 
std::string m_copyright
 Copyright notice. More...
 
std::string m_description
 A brief description about the catalog. More...
 
std::string m_name
 Catalog name. More...
 
std::string m_onlineResource
 A link location for more information on the catalog. More...
 

Detailed Description

A catalog for color schemes.

A color scheme catalog contains several color scheme groups that can be choosed by the user in order to color a given map.

See also
ColorScheme, ColorSchemeGroup, ColorSchemeCatalogManager
Note
Any doubts, please, send us an e-mail to help improve the documentation quality!

Definition at line 58 of file ColorSchemeCatalog.h.

Constructor & Destructor Documentation

te::color::ColorSchemeCatalog::ColorSchemeCatalog ( const std::string &  name)

It initializes a new ColorSchemeCatalog.

Parameters
nameThe catalog name.
te::color::ColorSchemeCatalog::~ColorSchemeCatalog ( )

Destructor.

te::color::ColorSchemeCatalog::ColorSchemeCatalog ( const ColorSchemeCatalog rhs)
private

Copy constructor not allowed.

Parameters
rhsThe right-hand-side copy that would be used to copy from.

Member Function Documentation

void te::color::ColorSchemeCatalog::disconnect ( ColorSchemeGroup group)

It removes the internal reference to the group.

Parameters
groupThe group to remove the internal reference.
Note
The caller of thi smethod will take the ownership of the group.
const std::string& te::color::ColorSchemeCatalog::getAuthor ( ) const

It returns the catalog author name.

Returns
The catalog author name.
const std::vector<ColorSchemeGroup*>& te::color::ColorSchemeCatalog::getColorSchemeGroups ( ) const

It returns the list of color scheme groups in the catalog.

Returns
The list of color scheme groups in the catalog.
const std::string& te::color::ColorSchemeCatalog::getCopyright ( ) const

It returns the catalog copyright notice.

Returns
The catalog copyright notice.
const std::string& te::color::ColorSchemeCatalog::getDescription ( ) const

It returns the catalog description.

Returns
The catalog description.
const std::string& te::color::ColorSchemeCatalog::getName ( ) const

It returns the catalog name.

Returns
The catalog name.
const std::string& te::color::ColorSchemeCatalog::getOnlineResource ( ) const

It returns a link for more information about the catalog.

Returns
A link for more information about the catalog.
ColorSchemeCatalog& te::color::ColorSchemeCatalog::operator= ( const ColorSchemeCatalog rhs)
private

Assignment operator not allowed.

Parameters
rhsThe right-hand-side copy that would be used to copy from.
Returns
A reference to this object.
void te::color::ColorSchemeCatalog::push_back ( ColorSchemeGroup group)

It adds a new group to the catalog and sets its relationship.

Parameters
groupThe group that will take part of the catalog.
Note
The catalog will take the ownership of the group.
Don't inform a NULL pointer.
void te::color::ColorSchemeCatalog::setAuthor ( const std::string &  author)

It sets the catalog author name.

Parameters
authorThe catalog author name.
void te::color::ColorSchemeCatalog::setCopyright ( const std::string &  c)

It sets the catalog copyright notice.

Parameters
cThe catalog copyright notice.
void te::color::ColorSchemeCatalog::setDescription ( const std::string &  d)

It sets the catalog description.

Parameters
dThe catalog description.
void te::color::ColorSchemeCatalog::setName ( const std::string &  newName)

It changes the catalog name and adjusts its entry in the catalog manager if needed.

Parameters
newNameThe new catalog name (must be a non-empty value).
void te::color::ColorSchemeCatalog::setOnlineResource ( const std::string &  r)

It sets the link for more information about the catalog.

Parameters
rThe link for more information about the catalog.

Member Data Documentation

std::string te::color::ColorSchemeCatalog::m_author
private

Information about catalog author.

Definition at line 212 of file ColorSchemeCatalog.h.

std::vector<ColorSchemeGroup*> te::color::ColorSchemeCatalog::m_colorSchemeGroups
private

The color scheme groups.

Definition at line 215 of file ColorSchemeCatalog.h.

std::string te::color::ColorSchemeCatalog::m_copyright
private

Copyright notice.

Definition at line 213 of file ColorSchemeCatalog.h.

std::string te::color::ColorSchemeCatalog::m_description
private

A brief description about the catalog.

Definition at line 211 of file ColorSchemeCatalog.h.

std::string te::color::ColorSchemeCatalog::m_name
private

Catalog name.

Definition at line 210 of file ColorSchemeCatalog.h.

std::string te::color::ColorSchemeCatalog::m_onlineResource
private

A link location for more information on the catalog.

Definition at line 214 of file ColorSchemeCatalog.h.


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