extras/vom/vom/singular_db_funcs.hpp

   1 /*
   2  * Copyright (c) 2017 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef __VOM_INST_DB_FUNCS_H__
  17 #define __VOM_INST_DB_FUNCS_H__
  18
  19 #include <ostream>
  20
  21 #include "singular_db.hpp"
  22
  23 /**
  24  * A set of helper function to iterate over objects in the DB.
  25  * These functions are delcared not as DB member functions so that
  26  * the template instatiation of the DB does not require the definitions
  27  * of the functions used to be declared.
  28  */
  29 namespace VOM {
  30 /**
  31  * Print each of the objects in the DB into the stream provided
  32  */
  33 template <typename DB>
  34 void
  35 db_dump(const DB& db, std::ostream& os)
  36 {
  37   for (const auto entry : db) {
  38     os << "key: " << entry.first << std::endl;
  39     os << "  " << entry.second.lock()->to_string() << std::endl;
  40   }
  41 }
  42 };
  43
  44 /*
  45  * fd.io coding-style-patch-verification: ON
  46  *
  47  * Local Variables:
  48  * eval: (c-set-style "mozilla")
  49  * End:
  50  */
  51
  52 #endif