ble_ln_db.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. /**
  2. * Copyright (c) 2015 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. /** @file
  41. *
  42. * @defgroup ble_sdk_srv_ln_db Location and Navigation database
  43. * @{
  44. * @ingroup ble_sdk_srv
  45. * @brief Location and Navigation route database
  46. */
  47. #ifndef BLE_LN_DB__
  48. #define BLE_LN_DB__
  49. #include "ble_lns.h"
  50. #ifdef __cplusplus
  51. extern "C" {
  52. #endif
  53. /**@brief Function for initializing the route database.
  54. *
  55. * @details This call initializes the database holding route records.
  56. *
  57. * @return NRF_SUCCESS on success.
  58. */
  59. void ble_ln_db_init(void);
  60. /**@brief Function for getting the number of records in the database.
  61. *
  62. * @details This call returns the number of records in the database.
  63. *
  64. * @return Number of records in the database.
  65. */
  66. uint16_t ble_ln_db_num_records_get(void);
  67. /**@brief Function for getting a record from the database.
  68. *
  69. * @details This call returns a specified record from the database.
  70. *
  71. * @param[in] record_num Index of the record to retrieve.
  72. * @param[out] p_rec Pointer to record structure where retrieved record is copied to.
  73. *
  74. * @return NRF_SUCCESS on success.
  75. */
  76. ret_code_t ble_ln_db_record_get(uint8_t record_num, ble_lns_route_t * p_rec);
  77. /**@brief Function for getting a record name from the database.
  78. *
  79. * @details This call returns a specified record name from the database.
  80. *
  81. * @param[in] rec_ndx Index of the record to retrieve.
  82. * @param[out] p_buf Pointer to array where retrieved record name is copied to.
  83. *
  84. * @return NRF_SUCCESS on success.
  85. */
  86. ret_code_t ble_ln_db_record_name_get(uint8_t rec_ndx, uint8_t ** p_buf);
  87. /**@brief Function for adding a record at the end of the database.
  88. *
  89. * @details This call adds a record as the last record in the database.
  90. *
  91. * @param[in] p_rec Pointer to record to add to database.
  92. *
  93. * @return NRF_SUCCESS on success.
  94. */
  95. ret_code_t ble_ln_db_record_add(ble_lns_route_t * p_rec);
  96. /**@brief Function for deleting a database entry.
  97. *
  98. * @details This call deletes an record from the database.
  99. *
  100. * @param[in] record_num Index of record to delete.
  101. *
  102. * @return NRF_SUCCESS on success.
  103. */
  104. ret_code_t ble_ln_db_record_delete(uint8_t record_num);
  105. #ifdef __cplusplus
  106. }
  107. #endif
  108. #endif // BLE_LN_DB_H__
  109. /** @} */