CommunicatorEvents.h

/**
 * @file    SwitchEvents.h
 * @brief   Collects events (wosh::Fact extension) related to Switch and Dimmer devices.
 *
 * @see     wosh::devices::UserAvailabilityChanged [wosh::interfaces::communication::Switch]
 * @see     wosh::devices::Dimmer_StateChanged [wosh::interfaces::communication::Dimmer]
 ****************************************************************************
 * @version 0.8.462 $Id: CommunicatorEvents.h 3775 2011-01-01 16:38:17Z alex $
 * @author  Alessandro Polo
 ****************************************************************************/
/* Copyright (c) 2007-2011, WOSH - Wide Open Smart Home 
 * by Alessandro Polo - OpenSmartHome.com
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSmartHome.com WOSH nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY Alessandro Polo ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Alessandro Polo BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ****************************************************************************/

#ifndef __WOSH_RMI_Events_SwitchEvents_H__
 #define __WOSH_RMI_Events_SwitchEvents_H__

 #include <woshDefs.h>
 #include <rmi/IEvent.h>
 #include <interfaces/communication/Communicator.h>


namespace wosh {
 namespace rmi {
  namespace events {

/**
 * @class   
 * @brief   
 *
 * @see     wosh::Fact
 * @see     wosh::interfaces::communication::Switch
 ****************************************************************************
 * @version 0.8.462 $Id: CommunicatorEvents.h 3775 2011-01-01 16:38:17Z alex $
 * @author  Alessandro Polo
 ****************************************************************************/
class UserAvailabilityChanged :     public wosh::rmi::IEvent,
                                public wosh::interfaces::communication::UserAvailabilityChanged
 {
    WOSH_SERIALIZABLE(wosh::rmi::events::UserAvailabilityChanged)

    public:
        /**
         * @brief  Empty constructor.
         */
        UserAvailabilityChanged()
            : IEvent(_Communicator_EVENT_AvailabilityChanged) { }

        UserAvailabilityChanged( const std::string& username, wosh::interfaces::communication::USER_AVAILABILITY presence_state,
                                        long previous_last_seen = 0 );

        /**
         * @brief  Copy constructor.
         * @param m [in] the source object to be copied
         */
        UserAvailabilityChanged( const UserAvailabilityChanged& m )
            : IEvent(m) { }
        /**
         * @brief  Empty destructor.
         */
        virtual ~UserAvailabilityChanged() { }

    public:
        virtual inline std::string getUserName() const      { return getUserName(this); }

        virtual wosh::interfaces::communication::USER_AVAILABILITY getPresenceState() const {
            return getPresenceState(this);
         }

        virtual inline int64 getPreviousLastSeen() const    { return getPreviousLastSeen(this); }

    public:
        static std::string getUserName( const Fact* fact );
        static wosh::interfaces::communication::USER_AVAILABILITY getPresenceState( const Fact* fact );
        static int64 getPreviousLastSeen( const Fact* fact );

        static UserAvailabilityChanged* fromFact( const Fact* fact );

    public:
        /**
         * @brief   Get a human friendly description of the event
         * @return  string such as "Switch is on"
         */
        virtual std::string toString() const;


}; // class def
//---------------------------------------------------------------------------------------------------------------



class UserInteraction : public wosh::rmi::IEvent,
                                        public wosh::interfaces::communication::UserInteraction
 {
    WOSH_SERIALIZABLE(wosh::rmi::events::UserInteraction)

    public:
        /**
         * @brief  Empty constructor.
         */
        UserInteraction()
            : IEvent(_Communicator_EVENT_UserInteraction) { }

        UserInteraction( const std::string& username, double availability = -1.0 );

        /**
         * @brief  Copy constructor.
         * @param m [in] the source object to be copied
         */
        UserInteraction( const UserInteraction& m )
            : IEvent(m) { }
        /**
         * @brief  Empty destructor.
         */
        virtual ~UserInteraction() { }

    public:
        virtual inline std::string getUserName() const      { return getUserName(this); }
        virtual inline double getAvailability()  const      { return getAvailability(this); }

    public:
        static std::string getUserName( const Fact* fact );
        static double getAvailability( const Fact* fact );

        static UserInteraction* fromFact( const Fact* fact );

    public:
        /**
         * @brief   Get a human friendly description of the event
         * @return  string such as "Switch is on"
         */
        virtual std::string toString() const;


}; // class def
//---------------------------------------------------------------------------------------------------------------


  }; // namespace events
 }; // namespace rmi
}; // namespace wosh


#endif //__WOSH_RMI_Events_SwitchEvents_H__