All Classes Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
Glympse::ITrackBuilder Struct Referenceabstract

The interface to construct and initialize track objects. More...

#include <ITrackBuilder.h>

Inheritance diagram for Glympse::ITrackBuilder:
Inheritance graph
[legend]

Public Member Functions

virtual void addLocation (const GLocation &location)=0
 Adds location to the track. More...
 
virtual void setSource (int32 source)=0
 Specifies track source. More...
 
virtual void setDistance (int32 distance)=0
 Specifies track distance. More...
 
virtual void calculateDistance ()=0
 Calculates track distance based on location data already populated.
 
virtual GTrack getTrack ()=0
 Returns track object constructed by the builder. More...
 
- Public Member Functions inherited from Glympse::ICommon
virtual int32 retain ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 release ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hold ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 unhold ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hashCode ()=0
 Returns an integer hash code for this object.
 
virtual bool equals (const GCommonObj &o)=0
 Compares this instance with the specified object and indicates if they are equal. More...
 
virtual GString toString ()=0
 Returns a string containing a concise, human-readable description of this object. More...
 
virtual void attachObject (const GCommon &obj)=0
 Asociates arbitrary object with the instance.
 
virtual GCommon extractObject ()=0
 Extracts associated object or NULL if no association is established.
 

Additional Inherited Members

- Protected Member Functions inherited from Glympse::ICommon
virtual ~ICommon ()
 Destructor is protected to deny explicit object deallocation. More...
 

Detailed Description

The interface to construct and initialize track objects.

It is recommended to construct track builder objects and populate it with location data on background thread from performance considerations. Parsing track information and converting it in an alternative representation can be pretty resource consuming operation.

However, applying it to the platform (by calling ITicket::updateRoute) has to be done on the same thread where platform was instantiated.

Member Function Documentation

virtual void Glympse::ITrackBuilder::addLocation ( const GLocation location)
pure virtual

Adds location to the track.

Parameters
locationLocation object to add.
virtual GTrack Glympse::ITrackBuilder::getTrack ( )
pure virtual

Returns track object constructed by the builder.

Returns
Prepared track object.
virtual void Glympse::ITrackBuilder::setDistance ( int32  distance)
pure virtual

Specifies track distance.

Parameters
distanceTrack distance in meters.
virtual void Glympse::ITrackBuilder::setSource ( int32  source)
pure virtual

Specifies track source.

See GC::TRACK_SOURCE_* for the list of supported sources or contact partn.nosp@m.ers@.nosp@m.glymp.nosp@m.se.c.nosp@m.om, if any particular source is not on the list yet.

Parameters
sourceThe source of track data.

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