inc/engine/common/Operators.h

   1 /*
   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
  10  *
  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.
  16  */
  17
  18 #ifndef OPERATORS_H
  19 #define OPERATORS_H
  20
  21 #include "common/HereMaps_global.h"
  22
  23 #include <iostream>
  24
  25 HERE_MAPS_BEGIN_NAMESPACE
  26
  27 class Result;
  28 class Address;
  29 class MetaInfo;
  30 class GeoLocation;
  31 class GeoCoordinates;
  32
  33 HERE_MAPS_END_NAMESPACE
  34
  35 //add operators to global namespace
  36
  37 /**
  38  * This is an operator that inserts the contents of a <code>Result</code> object
  39  * into the output steam.
  40  *
  41  * @param os A reference to the output stream to which the right-hand object is inserted.
  42  *
  43  * @param rResult A constant reference to an object whose contents are to be
  44  *        inserted (output).
  45  *
  46  * @return A reference to the output stream after insertion.
  47  */
  48 std::ostream& operator<<(std::ostream& os, const HERE_MAPS_NAMESPACE_PREFIX::Result& rResult);
  49
  50 /**
  51  * This is an operator that inserts the contents of a <code>MetaInfo</code>
  52  * object into the output steam.
  53  *
  54  * @param os A reference to the output stream to which the right-hand object is
  55  *        inserted.
  56  *
  57  * @param rMetaInfo A constant reference to an object whose contents are to be
  58  *        inserted (output).
  59  *
  60  * @return A reference to the output stream after insertion.
  61  */
  62 std::ostream& operator<<(std::ostream& os, const HERE_MAPS_NAMESPACE_PREFIX::MetaInfo& rMetaInfo);
  63
  64 /**
  65  * This is an operator that inserts the contents of a <code>GeoLocation</code>
  66  * object into the output steam.
  67  *
  68  * @param os A reference to the output stream to which the right-hand object is
  69  *        inserted.
  70  *
  71  * @param rLocation A constant reference to an object whose contents are to be
  72  *        inserted (output).
  73  *
  74  * @return A reference to the output stream after insertion.
  75  */
  76 std::ostream& operator<<(std::ostream& os, const HERE_MAPS_NAMESPACE_PREFIX::GeoLocation& rLocation);
  77
  78 /**
  79  * This is an operator that inserts the contents of an <code>Address</code>
  80  * object into the output steam.
  81  *
  82  * @param os A reference to the output stream to which the right-hand object is
  83  *        inserted.
  84  *
  85  * @param rAddress A constant reference to an object whose contents are to be
  86  *        inserted (output).
  87  *
  88  * @return A reference to the output stream after insertion.
  89  */
  90 std::ostream& operator<<(std::ostream& os, const HERE_MAPS_NAMESPACE_PREFIX::Address& rAddress);
  91
  92 /**
  93  * This is an operator that inserts the contents of a
  94  * <code>GeoCoordinates</code> object into the output steam.
  95  *
  96  * @param os A reference to the output stream to which the right-hand object is
  97  *        inserted.
  98  *
  99  * @param rCoord A constant reference to an object whose contents are to be
 100  *        inserted (output).
 101  *
 102  * @return A reference to the output stream after insertion.
 103  */
 104 std::ostream& operator<<(std::ostream& os, const HERE_MAPS_NAMESPACE_PREFIX::GeoCoordinates& rCoord);
 105
 106 #endif