1 /*
2 * Copyright (c) 2017-2019, The OpenThread Authors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. Neither the name of the copyright holder nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /**
30 * @file
31 * This file includes definitions locator getter methods.
32 *
33 */
34
35 #ifndef LOCATOR_GETTERS_HPP_
36 #define LOCATOR_GETTERS_HPP_
37
38 #include "openthread-core-config.h"
39
40 #include "common/instance.hpp"
41 #include "common/locator.hpp"
42
43 namespace ot {
44
45 /**
46 * This method returns a reference to the parent OpenThread Instance.
47 *
48 * This definition is a specialization of template `Get<Type>` for `Get<Instance>()`,
49 *
50 * @returns A reference to `Instance` object.
51 *
52 */
Get(void) const53 template <> inline Instance &InstanceLocator::Get(void) const
54 {
55 return GetInstance();
56 }
57
Get(void) const58 template <typename Type> inline Type &InstanceLocator::Get(void) const
59 {
60 // This method uses the `Instance` template method `Get<Type>`
61 // to get to the given `Type` from the single OpenThread
62 // instance.
63 return GetInstance().Get<Type>();
64 }
65
66 } // namespace ot
67
68 #endif // LOCATOR_GETTERS_HPP_
69
