• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2015, Intel Corporation
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice, this
9  * list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation and/or
13  * other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 #pragma once
31 
32 #include <SubsystemObject.h>
33 #include <AlwaysAssert.hpp>
34 #include <string>
35 
36 class CMappingContext;
37 
38 namespace parameterFramework
39 {
40 namespace introspectionSubsystem
41 {
42 
43 /** This subsystem object exposes a boolean parameter. The value of this parameter
44  * can be retrieved by an external code that calls the getSingletonInstanceValue()
45  * static method.
46  */
47 class SubsystemObject final : public CSubsystemObject
48 {
49 public:
50     SubsystemObject(const std::string &mappingValue,
51                     CInstanceConfigurableElement *instanceConfigurableElement,
52                     const CMappingContext &context, core::log::Logger &logger);
53     ~SubsystemObject();
54 
getSingletonInstanceValue()55     static bool getSingletonInstanceValue()
56     {
57         ALWAYS_ASSERT(mSingletonInstance != nullptr, "Singleton value has not been registered");
58         return mSingletonInstance->mParameter;
59     }
60 
61 private:
62     using base = CSubsystemObject;
63 
64     virtual bool sendToHW(std::string &error) override;
65     virtual bool receiveFromHW(std::string &error) override;
66 
registerInstance(const SubsystemObject & instance)67     static void registerInstance(const SubsystemObject &instance)
68     {
69         ALWAYS_ASSERT(mSingletonInstance == nullptr, "An instance is already registered");
70         mSingletonInstance = &instance;
71     }
72 
unregisterInstance(const SubsystemObject & instance)73     static void unregisterInstance(const SubsystemObject &instance)
74     {
75         // instance parameter is only used by assertion, so unused in release mode
76         (void)instance;
77 
78         ALWAYS_ASSERT(mSingletonInstance == &instance, "This instance was not registered.");
79         mSingletonInstance = nullptr;
80     }
81 
82     static const std::size_t parameterSize = sizeof(bool);
83 
84     static const SubsystemObject *mSingletonInstance;
85 
86     bool mParameter;
87 };
88 } // namespace introspectionSubsystem
89 } // namespace parameterFramework
90