LampGroupManager.h 24.6 KB
Newer Older
Nicolas Metts's avatar
Nicolas Metts committed
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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
#ifndef _LAMP_GROUP_MANAGER_H_
#define _LAMP_GROUP_MANAGER_H_
/**
 * \ingroup ControllerClient
 */

/**
 * \file  lighting_controller_client/inc/LampGroupManager.h
 * This file provides definitions for the Lamp Group Manager
 */

/******************************************************************************
 * 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.
 ******************************************************************************/

#include <list>

#include <Manager.h>
#include <ControllerClientDefs.h>


namespace lsf {

class ControllerClient;

/**
 * Abstract base class implemented by User Application Developers. \n
 * The callbacks defined in this class allow the User Application
 * to be informed when Lamp Groups specific specific AllJoyn method
 * replies or signals are received from the Lighting Controller
 * Service.
 */
class LampGroupManagerCallback {
  public:

    /**
     * Destructor
     */
    virtual ~LampGroupManagerCallback() { }

    /**
     * Indicates that a reply has been received for the method call GetAllLampGroupIDs method call.
     *
     * @param responseCode   The response code
     * @param lampGroupIDs   Lamp Group IDs
     */
    virtual void GetAllLampGroupIDsReplyCB(const LSFResponseCode& responseCode, const LSFStringList& lampGroupIDs) { }

    /**
     * Indicates that a reply has been received for the method call GetLampGroupName method call.
     *
     * @param responseCode   The response code
     * @param lampGroupID    The Lamp Group ID
     * @param language
     * @param lampGroupName  The Lamp Group Name
     */
    virtual void GetLampGroupNameReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID, const LSFString& language, const LSFString& lampGroupName) { }

    /**
     * Indicates that a reply has been received for the SetLampGroupName method call.
     *
     * @param responseCode   The response code
     * @param lampGroupID    The Lamp Group ID
     * @param language
     */
    virtual void SetLampGroupNameReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID, const LSFString& language) { }

    /**
     * Indicates that the signal LampGroupsNameChanged has been received.
     *
     * @param lampGroupIDs    The Lamp Group IDs
     */
    virtual void LampGroupsNameChangedCB(const LSFStringList& lampGroupIDs) { }

    /**
     * Indicates that a reply has been received for the CreateLampGroup method call.
     *
     * @param responseCode   The response code
     * @param lampGroupID    The Lamp Group ID
     */
    virtual void CreateLampGroupReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     *  Indicates that the signal LampGroupsCreated has been received.
     *
     *  @param lampGroupIDs   The Lamp Group IDs
     */
    virtual void LampGroupsCreatedCB(const LSFStringList& lampGroupIDs) { }

    /**
     * Indicates that a reply has been received for the GetLampGroup method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     * @param lampGroup       The Lamp Group
     */
    virtual void GetLampGroupReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID, const LampGroup& lampGroup) { }

    /**
     * Indicates that a reply has been received for the DeleteLampGroup method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void DeleteLampGroupReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     *  Indicates that the signal LampGroupsDeleted has been received.
     *
     *  @param lampGroupIDs   The Lamp Group IDs
     */
    virtual void LampGroupsDeletedCB(const LSFStringList& lampGroupIDs) { }

    /**
     * Indicates that a reply has been received for the TransitionLampGroupState method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void TransitionLampGroupStateReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the PulseLampGroupWithState method call.
     *
     * @param responseCode    The response code
     * @param lampID          The LampGroup ID
     */
    virtual void PulseLampGroupWithStateReplyCB(const LSFResponseCode& responseCode, const LSFString& lampID) { }

    /**
     * Indicates that a reply has been received for the TransitionLampGroupPreset method call.
     *
     * @param responseCode    The response code
     * @param lampID          The LampGroup ID
     */
    virtual void PulseLampGroupWithPresetReplyCB(const LSFResponseCode& responseCode, const LSFString& lampID) { }

    /**
     * Indicates that a reply has been received for the TransitionLampGroupStateField method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void TransitionLampGroupStateOnOffFieldReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the TransitionLampGroupStateField method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void TransitionLampGroupStateHueFieldReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the TransitionLampGroupStateField method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void TransitionLampGroupStateSaturationFieldReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the TransitionLampGroupStateField method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void TransitionLampGroupStateBrightnessFieldReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the TransitionLampGroupStateField method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void TransitionLampGroupStateColorTempFieldReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the ResetLampGroupState method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void ResetLampGroupStateReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the ResetLampGroupStateField method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void ResetLampGroupStateOnOffFieldReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the ResetLampGroupStateField method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void ResetLampGroupStateHueFieldReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the ResetLampGroupStateField method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void ResetLampGroupStateSaturationFieldReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the ResetLampGroupStateField method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void ResetLampGroupStateBrightnessFieldReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the ResetLampGroupStateField method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void ResetLampGroupStateColorTempFieldReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that a reply has been received for the UpdateLampGroup method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void UpdateLampGroupReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Indicates that the signal LampGroupsUpdated has been received.
     *
     * @param lampGroupIDs    The Lamp Group IDs
     */
    virtual void LampGroupsUpdatedCB(const LSFStringList& lampGroupIDs) { }

    /**
     * Indicates that a reply has been received for the TransitionLampGroupStateToPreset method call.
     *
     * @param responseCode    The response code
     * @param lampGroupID     The Lamp Group ID
     */
    virtual void TransitionLampGroupStateToPresetReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID) { }

    /**
     * Set Lamp Group Effect Reply CB
     * @param responseCode
     * @param lampGroupID   - The requested lamp id
     * @param effectID - the requested effect id
     */
    virtual void SetLampGroupEffectReplyCB(const LSFResponseCode& responseCode, const LSFString& lampGroupID, const LSFString& effectID) { }
};

/**
 * This class exposes the APIs that the User Application can use to manage
 * Lamp Groups
 */
class LampGroupManager : public Manager {

    friend class ControllerClient;

  public:

    /**
     * Constructor
     */
    LampGroupManager(ControllerClient& controller, LampGroupManagerCallback& callback);

    /**
     * Get the IDs of all the Lamp Groups. \n
     * Response in LampGroupManagerCallback::GetAllLampGroupIDsReplyCB
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus GetAllLampGroupIDs(void);

    /**
     * Get the name of a Lamp Group. \n
     * Response in LampGroupManagerCallback::GetLampGroupNameCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @param language
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus GetLampGroupName(const LSFString& lampGroupID, const LSFString& language = LSFString("en"));

    /**
     * Set the name of the specified Lamp Group. \n
     * Response in LampGroupManagerCallback::SetLampGroupNameReplyCB
     *
     * @param lampGroupID The Lamp Group ID
     * @param lampGroupName        The Lamp Group Name
     * @param language
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus SetLampGroupName(const LSFString& lampGroupID, const LSFString& lampGroupName, const LSFString& language = LSFString("en"));

    /**
     * Create a new Lamp Group. \n
     * Response in LampGroupManagerCallback::CreateLampGroupReplyCB
     *
     * @param lampGroup   Lamp Group
     * @param lampGroupName
     * @param language
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus CreateLampGroup(const LampGroup& lampGroup, const LSFString& lampGroupName, const LSFString& language = LSFString("en"));

    /**
     * Modify a Lamp Group. \n
     * Response in LampGroupManagerCallback::UpdateLampGroupReplyCB
     *
     * @param lampGroupID  The Lamp Group ID
     * @param lampGroup    Lamp Group
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus UpdateLampGroup(const LSFString& lampGroupID, const LampGroup& lampGroup);

    /**
     * Get the information about a Lamp Group. \n
     * Response in LampGroupManagerCallback::GetLampGroupReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus GetLampGroup(const LSFString& lampGroupID);

    /**
     * Delete a Lamp Group. \n
     * Response in LampGroupManagerCallback::DeleteLampGroupReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus DeleteLampGroup(const LSFString& lampGroupID);

    /**
     * Transition a Lamp Group to a new state. \n
     * Response in LampGroupManagerCallback::TransitionLampGroupStateReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @param lampGroupState The new state
     * @param transitionPeriod
     *
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus TransitionLampGroupState(const LSFString& lampGroupID, const LampState& lampGroupState, const uint32_t& transitionPeriod = 0);

    /**
     * Pulse the LampGroup to a given state. \n
     * Response in LampGroupManagerCallback::PulseLampGroupWithStateReplyCB
     */
    ControllerClientStatus PulseLampGroupWithState(const LSFString& lampGroupID, const LampState& toLampGroupState, const uint32_t& period, const uint32_t& duration, const uint32_t& numPulses, const LampState& fromLampGroupState = LampState());

    /**
     * Pulse the LampGroup to a given state. \n
     * Response in LampGroupManagerCallback::PulseLampGroupWithPresetReplyCB
     */
    ControllerClientStatus PulseLampGroupWithPreset(const LSFString& lampGroupID, const LSFString& toPresetID, const uint32_t& period, const uint32_t& duration, const uint32_t& numPulses, const LSFString& fromPresetID = CurrentStateIdentifier);

    /**
     * Transition a Lamp Group's field to a given value. \n
     * Response in LampGroupManagerCallback::TransitionLampGroupStateFieldReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @param onOff
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus TransitionLampGroupStateOnOffField(const LSFString& lampGroupID, const bool& onOff) {
        LSFString name("OnOff");
        return TransitionLampGroupStateBooleanField(lampGroupID, name, onOff);
    }

    /**
     * Transition a Lamp Group's field to a given value. \n
     * Response in LampGroupManagerCallback::TransitionLampGroupStateFieldReplyCB
     *
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus TransitionLampGroupStateHueField(const LSFString& lampGroupID, const uint32_t& hue, const uint32_t& transitionPeriod = 0) {
        LSFString name("Hue");
        return TransitionLampGroupStateIntegerField(lampGroupID, name, hue, transitionPeriod);
    }

    /**
     * Transition a Lamp Group's field to a given value. \n
     * Response in LampGroupManagerCallback::TransitionLampGroupStateFieldReplyCB
     *
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus TransitionLampGroupStateSaturationField(const LSFString& lampGroupID, const uint32_t& saturation, const uint32_t& transitionPeriod = 0) {
        LSFString name("Saturation");
        return TransitionLampGroupStateIntegerField(lampGroupID, name, saturation, transitionPeriod);
    }

    /**
     * Transition a Lamp Group's field to a given value. \n
     * Response in LampGroupManagerCallback::TransitionLampGroupStateFieldReplyCB
     */
    ControllerClientStatus TransitionLampGroupStateBrightnessField(const LSFString& lampGroupID, const uint32_t& brightness, const uint32_t& transitionPeriod = 0) {
        LSFString name("Brightness");
        return TransitionLampGroupStateIntegerField(lampGroupID, name, brightness, transitionPeriod);
    }

    /**
     * Transition a Lamp Group's field to a given value. \n
     * Response in LampGroupManagerCallback::TransitionLampGroupStateFieldReplyCB
     */
    ControllerClientStatus TransitionLampGroupStateColorTempField(const LSFString& lampGroupID, const uint32_t& colorTemp, const uint32_t& transitionPeriod = 0) {
        LSFString name("ColorTemp");
        return TransitionLampGroupStateIntegerField(lampGroupID, name, colorTemp, transitionPeriod);
    }

    /**
     * Transition a Lamp Group to a given Preset. \n
     * Response in LampGroupManagerCallback::TransitionLampGroupStateToPresetReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @param presetID   The Preset ID
     * @param transitionPeriod
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus TransitionLampGroupStateToPreset(const LSFString& lampGroupID, const LSFString& presetID, const uint32_t& transitionPeriod = 0);

    /**
     * Reset a Lamp Group's state. \n
     * Got to each lamp and reset its state. \n
     * Response in LampGroupManagerCallback::ResetLampGroupStateReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus ResetLampGroupState(const LSFString& lampGroupID);

    /**
     * Reset a Lamp Group's OnOff field to a given value. \n
     * Response in LampGroupManagerCallback::ResetLampGroupStateFieldReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus ResetLampGroupStateOnOffField(const LSFString& lampGroupID) {
        LSFString name("OnOff");
        return ResetLampGroupStateField(lampGroupID, name);
    }

    /**
     * Reset a Lamp Group's Hue field to a given value. \n
     * Response in LampGroupManagerCallback::ResetLampGroupStateFieldReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus ResetLampGroupStateHueField(const LSFString& lampGroupID) {
        LSFString name("Hue");
        return ResetLampGroupStateField(lampGroupID, name);
    }

    /**
     * Reset a Lamp Group's Saturation field to a given value. \n
     * Response in LampGroupManagerCallback::ResetLampGroupStateFieldReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus ResetLampGroupStateSaturationField(const LSFString& lampGroupID) {
        LSFString name("Saturation");
        return ResetLampGroupStateField(lampGroupID, name);
    }

    /**
     * Reset a Lamp Group's Brightness field to a given value. \n
     * Response in LampGroupManagerCallback::ResetLampGroupStateFieldReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus ResetLampGroupStateBrightnessField(const LSFString& lampGroupID) {
        LSFString name("Brightness");
        return ResetLampGroupStateField(lampGroupID, name);
    }

    /**
     * Reset a Lamp Group's ColorTemp field to a given value. \n
     * Response in LampGroupManagerCallback::ResetLampGroupStateFieldReplyCB
     *
     * @param lampGroupID    The Lamp Group ID
     * @return
     *      - CONTROLLER_CLIENT_OK if successful
     *      - An error status otherwise
     *
     */
    ControllerClientStatus ResetLampGroupStateColorTempField(const LSFString& lampGroupID) {
        LSFString name("ColorTemp");
        return ResetLampGroupStateField(lampGroupID, name);
    }

    /**
     * Get the Lamp Group Info and Name
     *
     * @param lampGroupID    The ID of the group
     * @param language
     */
    ControllerClientStatus GetLampGroupDataSet(const LSFString& lampGroupID, const LSFString& language = LSFString("en"));

    /**
     * Set the effect defined by effectID on the lamp group identified by lamp group ID \n
     * @param lampGroupID
     * @param effectID
     * @return ControllerClientStatus
     */
    ControllerClientStatus SetLampGroupEffect(const LSFString& lampGroupID, const LSFString& effectID);

  private:

    ControllerClientStatus TransitionLampGroupStateIntegerField(const LSFString& lampGroupID, const LSFString& stateFieldName, const uint32_t& value, const uint32_t& transitionPeriod = 0);
    ControllerClientStatus TransitionLampGroupStateBooleanField(const LSFString& lampGroupID, const LSFString& stateFieldName, const bool& value);
    ControllerClientStatus ResetLampGroupStateField(const LSFString& lampGroupID, const LSFString& stateFieldName);

    /**
     * Handler for the signal LampGroupsNameChanged
     */
    void LampGroupsNameChanged(LSFStringList& idList);

    /**
     * Handler for the signal LampGroupsCreated
     */
    void LampGroupsCreated(LSFStringList& idList);

    /**
     * Handler for the signal LampGroupsDeleted
     */
    void LampGroupsDeleted(LSFStringList& idList);

    /**
     * Handler for the signal LampGroupsUpdated
     */
    void LampGroupsUpdated(LSFStringList& idList);

    /**
     * Method Reply Handler for the signal GetAllLampGroupIDs
     */
    void GetAllLampGroupIDsReply(LSFResponseCode& responseCode, LSFStringList& idList);

    /**
     * Method Reply Handler for the signal GetLampGroupName
     */
    void GetLampGroupNameReply(LSFResponseCode& responseCode, LSFString& lsfId, LSFString& language, LSFString& lsfName);

    /**
     * Method Reply Handler for the signal SetLampGroupName
     */
    void SetLampGroupNameReply(LSFResponseCode& responseCode, LSFString& lsfId, LSFString& language);

    /**
     * Method Reply Handler for the signal CreateLampGroup
     */
    void CreateLampGroupReply(LSFResponseCode& responseCode, LSFString& lsfId);

    /**
     * Method Reply Handler for the signal UpdateLampGroup
     */
    void UpdateLampGroupReply(LSFResponseCode& responseCode, LSFString& lsfId);

    /**
     * Method Reply Handler for the signal GetLampGroup
     */
    void GetLampGroupReply(ajn::Message& message);

    /**
     * Method Reply Handler for the signal DeleteLampGroup
     */
    void DeleteLampGroupReply(LSFResponseCode& responseCode, LSFString& lsfId);

    /**
     * Method Reply Handler for the signal ResetLampGroupStateField
     */
    void ResetLampGroupStateFieldReply(LSFResponseCode& responseCode, LSFString& lsfId, LSFString& lsfName);

    /**
     * Method Reply Handler for the signal ResetLampGroupState
     */
    void ResetLampGroupStateReply(LSFResponseCode& responseCode, LSFString& lsfId);

    /**
     * Method Reply Handler for the signal TransitionLampGroupState
     */
    void TransitionLampGroupStateReply(LSFResponseCode& responseCode, LSFString& lsfId);

    void PulseLampGroupWithStateReply(LSFResponseCode& responseCode, LSFString& lsfId);

    void PulseLampGroupWithPresetReply(LSFResponseCode& responseCode, LSFString& lsfId);

    /**
     * Method Reply Handler for the signal TransitionLampGroupStateField
     */
    void TransitionLampGroupStateFieldReply(LSFResponseCode& responseCode, LSFString& lsfId, LSFString& lsfName);

    /**
     * Method Reply Handler for the signal TransitionLampGroupStateToPreset
     */
    void TransitionLampGroupStateToPresetReply(LSFResponseCode& responseCode, LSFString& lsfId);

    /**
     * Callback used to send Lamp Group specific signals and method replies
     * to the User Application
     */
    LampGroupManagerCallback&   callback;
};


}

#endif