/usr/include/x86_64-linux-gnu/alljoyn/controlpanel/ControlPanelControllerUnit.h is in liballjoynservices-dev-1604 16.04-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | /******************************************************************************
* Copyright AllSeen Alliance. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
******************************************************************************/
#ifndef CONTROLPANELCONTROLLERUNIT_H_
#define CONTROLPANELCONTROLLERUNIT_H_
#include <qcc/String.h>
#include <alljoyn/Status.h>
#include <map>
#include <alljoyn/controlpanel/HttpControl.h>
namespace ajn {
namespace services {
class ControlPanelDevice;
class ControlPanel;
class NotificationAction;
/**
* Class that represents a ControlPanel Unit.
*/
class ControlPanelControllerUnit {
public:
/**
* ControlPanelUnit()
* @param unitName
* @param device
*/
ControlPanelControllerUnit(qcc::String const& unitName, ControlPanelDevice* device);
/**
* ~ControlPanelUnit()
*/
virtual ~ControlPanelControllerUnit();
/**
* add a HttpControl
* @param objectPath of HTTPControl
* @return status - success/failure
*/
QStatus addHttpControl(qcc::String const& objectPath);
/**
* addControlPanel
* @param objectPath
* @param panelName
* @return status - success/failure
*/
QStatus addControlPanel(qcc::String const& objectPath, qcc::String const& panelName);
/**
* addNotificationAction to controlpanel unit
* @param objectPath the objectpath of the notification action
* @param actionName - the actionName parsed from the objectpath
* @return status - success/failure
*/
QStatus addNotificationAction(qcc::String const& objectPath, qcc::String const& actionName);
/**
* remove a Notification Action
* @param actionName
* @return status - success/failure
*/
QStatus removeNotificationAction(qcc::String const& actionName);
/**
* Fill control panels and the HTTPControl
*/
QStatus registerObjects();
/**
* Called when shutting down device
* @return status - success/failure
*/
QStatus shutdownUnit();
/**
* getDevice()
* @return ControlPanelDevice*
*/
ControlPanelDevice* getDevice() const;
/**
* getUnitName()
* @return string
*/
const qcc::String& getUnitName() const;
/**
* Get the ControlPanels of the Unit
* @return controlPanels map
*/
const std::map<qcc::String, ControlPanel*>& getControlPanels() const;
/**
* Get the NotificationActions of the Unit
* @return NotificationActions map
*/
const std::map<qcc::String, NotificationAction*>& getNotificationActions() const;
/**
* Get a ControlPanel of the Unit
* @param panelName - name of the Panel to get
* @return ControlPanel or NULL if it doesn't' exist
*/
ControlPanel* getControlPanel(qcc::String const& panelName) const;
/**
* Get a NotificationAction of the Unit
* @param actionName - name of the NotificaitonAction to get
* @return NotificationAction or NULL if it doesn't exist
*/
NotificationAction* getNotificationAction(qcc::String const& actionName) const;
/**
* Get the HttpControl of the Unit
* @return httpControl
*/
HttpControl* getHttpControl() const;
private:
/**
* Name of Unit
*/
qcc::String m_UnitName;
/**
* Device Unit belongs to
*/
ControlPanelDevice* m_Device;
/**
* The ControlPanels of this Unit
*/
std::map<qcc::String, ControlPanel*> m_ControlPanels;
/**
* The NotificationActions of this Unit
*/
std::map<qcc::String, NotificationAction*> m_NotificationActions;
/**
* The HTTPControl of the Unit
*/
HttpControl* m_HttpControl;
};
} /* namespace services */
} /* namespace ajn */
#endif /* CONTROLPANELCONTROLLERUNIT_H_ */
|