2 * Copyright (C) 2013 HERE Global B.V. All rights reserved.
3 * This software, including documentation, is protected by copyright controlled by
4 * HERE Global B.V. (“Software”). All rights are reserved. Copying, including reproducing,
5 * storing, adapting or translating, any or all of this material requires the prior
6 * written consent of HERE Global B.V. You may use this
7 * Software in accordance with the terms and conditions defined in the
8 * HERE Location Platform Services Terms and Conditions, available at
9 * http://developer.here.com/terms-conditions-base
11 * As an additional permission to the above, you may distribute Software,
12 * in object code format as part of an Application, according to, and subject to, terms and
13 * conditions defined in the Tizen Software Development kit (“SDK”) License Agreement.
14 * You may distribute such object code format Application under terms of your choice,
15 * provided that the header and source files of the Software have not been modified.
22 #include "common/HereMaps_global.h"
23 #ifndef TIZEN_MIGRATION
27 HERE_MAPS_BEGIN_NAMESPACE
34 * This typedef defines a type representing a list of <code>Category</code>
39 typedef std::vector<Category> CategoryList;
42 * This class encapsulates information about a Point of Interest (POI) category
43 * that can be applied to a place.
47 class EXPORT_API Category
52 * This method is the default constructor.
57 * This method is a constructor.
59 Category(const CategoryId& rId);
62 * This method is a copy constructor.
64 * @param rRhs An object whose contents are to be copied to the instance
67 Category(const Category& rRhs);
70 * This method is the (virtual) destructor.
75 * This is the assignment operator.
77 * @param rRhs An object whose contents are to be copied to the given
80 * @return A reference to the given instance of the class after its contents
83 Category& operator=(const Category& rRhs);
86 * This method retrieves the category identifier.
88 * @return A string containing the identifier of the POI category.
90 const CategoryId& GetCategoryId() const;
93 * This method sets the category identifier.
95 * @param rsId A constant reference to an object containing the identifier
96 * of the POI category.
98 void SetCategoryId(const CategoryId& rsId);
101 * This method retrieves the category name (localized).
103 * @return A string containing the localized name of the POI category.
105 String GetTitle() const;
108 * This method retrieves the URI of the category resource (icon).
110 * @return A string containing the URI of the icon of the POI category.
112 String GetHref() const;
115 * This method retrieves the resource type identifier for the given
118 * @return A string containing the type identifier, which is either a valid
119 * MIME type or a URI.
121 String GetType() const;
124 * This method retrieves the path to the category icon.
126 * @return A URI object containing the path to the category icon.
128 String GetIconPath() const;
131 * This method sets the category name (localized).
133 * @param sTitle A constant reference to a string containing the localized
134 * name of the POI category.
136 void SetTitle(const String& sTitle);
139 * This method sets the URI of the category resource (icon).
141 * @param sHref A constant reference to a string containing the URI of the icon
142 * of the POI category.
144 void SetHref(const String& sHref);
147 * This method sets the resource type identifier for the given
150 * @param sType A constant reference to a string containing the type
151 * identifier, which is either a valid MIME type or a URI.
153 void SetType(const String& sType);
156 * This method sets the path to the category icon.
158 * @param rIcon A constant reference to a URI object containing the path to
161 void SetIconPath(const String& rIcon);
165 CategoryImpl* m_pImpl;
167 friend class JsonParser;
170 HERE_MAPS_END_NAMESPACE
172 #endif // CATEGORY_H_