CitySDK iOS Library
 All Classes Functions Variables Enumerations Enumerator Properties
Instance Methods | Properties | List of all members
Route Class Reference

A simple representation of a Route. More...

Inheritance diagram for Route:
POI POIType <Deserializable> POIBaseType

Instance Methods

(void) - addPoi:
 Adds a PointOfInterest to the Route. More...
 
(int) - getNumPois
 Gets the number of PointOfInterests that the Route has. More...
 
(PointOfInterest *) - getPoi:
 Gets the PointOfInterest in a given index of a Route. More...
 
- Instance Methods inherited from POI
(BOOL) - hasAdddress
 Checks whether the POI has an address associated. More...
 
- Instance Methods inherited from POIType
(void) - addLabel:
 Adds a label to the POIType. More...
 
(void) - addDescription:
 Adds a description to the POIType. More...
 
(void) - addCategory:
 Adds a category to the POIType. More...
 
(void) - addTime:
 Adds a time to the POIType. More...
 
(void) - addLink:
 Adds a link to the POIType. More...
 
(BOOL) - hasLabels
 Checks if there are labels in the POIType. More...
 
(BOOL) - hasDescriptions
 Checks if there are descriptions in the POIType. More...
 
(BOOL) - hasCategories
 Checks if there are categories in the POIType. More...
 
(BOOL) - hasTimes
 Checks if there are times in the POIType. More...
 
(BOOL) - hasLinks
 Checks if there are links in the POIType. More...
 

Properties

ListPointOfInterestpois
 Gets the ListPointOfInterest of the Route. More...
 
- Properties inherited from POI
Locationlocation
 
- Properties inherited from POIType
NSMutableArray * label
 a human-readable name. Multiple names are used for synonyms and multiple languages
 
NSMutableArray * poiDescription
 a human-readable description that can be discriminated with the language attribute
 
NSMutableArray * category
 a categorical classification
 
NSMutableArray * time
 a fixed time or sequence of times using iCalendar
 
NSMutableArray * link
 a link to another POI or web resource
 
- Properties inherited from POIBaseType
NSString * baseID
 a unique identifier for this POI. Can be a URI fragment
 
NSString * value
 the information content
 
NSString * href
 an absolute reference to the content type
 
NSString * type
 MIME type.
 
NSString * lang
 language type
 
NSString * base
 base URI
 
NSDate * created
 time at which this POIBaseType was created
 
NSDate * updated
 time at which this POIBaseType was updated
 
NSDate * deleted
 time at which this POIBaseType was deleted
 
POITermTypeauthor
 the author of this POIBaseType
 
POITermTypelicense
 the license restrictions of this information
 

Detailed Description

A simple representation of a Route.

A Route is a set of PointOfInterest ordered by a given theme - represented by a ListPointOfInterest.

Author
Pedro Cruz

Method Documentation

- (void) addPoi: (PointOfInterest *)  poi

Adds a PointOfInterest to the Route.

Parameters
poithe PointOfInterest to be added.
- (int) getNumPois

Gets the number of PointOfInterests that the Route has.

Returns
the number of total PointOfInterest.
- (PointOfInterest *) getPoi: (int)  i

Gets the PointOfInterest in a given index of a Route.

Parameters
ithe index of the PointOfInterest.
Returns
the PointOfInterest stored in the index.

Property Documentation

- (ListPointOfInterest *) pois
readatomicretain

Gets the ListPointOfInterest of the Route.

Returns
the ListPointOfInterest of the Route.

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