Notification.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  Notification.h
//
//  Contains details of a Z-Wave event reported to the user
//
//  Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
//
//  SOFTWARE NOTICE AND LICENSE
//
//  This file is part of OpenZWave.
//
//  OpenZWave is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation, either version 3 of the License,
//  or (at your option) any later version.
//
//  OpenZWave is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public License
//  along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
 
#ifndef _Notification_H
#define _Notification_H
 
#include "Defs.h"
#include "value_classes/ValueID.h"
 
namespace OpenZWave
{
    class OPENZWAVE_EXPORT Notification
    {
        friend class Manager;
        friend class Driver;
        friend class Node;
        friend class Group;
        friend class Value;
        friend class ValueStore;
        friend class Basic;
        friend class ManufacturerSpecific;
        friend class NodeNaming;
        friend class NoOperation;
        friend class SceneActivation;
        friend class WakeUp;
 
    public:
        enum NotificationType
        {
            Type_ValueAdded = 0,                
            Type_ValueRemoved,                  
            Type_ValueChanged,                  
            Type_ValueRefreshed,                
            Type_Group,                         
            Type_NodeNew,                       
            Type_NodeAdded,                     
            Type_NodeRemoved,                   
            Type_NodeProtocolInfo,              
            Type_NodeNaming,                    
            Type_NodeEvent,                     
            Type_PollingDisabled,               
            Type_PollingEnabled,                
            Type_SceneEvent,                    
            Type_CreateButton,                  
            Type_DeleteButton,                  
            Type_ButtonOn,                      
            Type_ButtonOff,                     
            Type_DriverReady,                   
            Type_DriverFailed,                  
            Type_DriverReset,                   
            Type_EssentialNodeQueriesComplete,  
            Type_NodeQueriesComplete,           
            Type_AwakeNodesQueried,             
            Type_AllNodesQueriedSomeDead,       
            Type_AllNodesQueried,               
            Type_Notification,                  
            Type_DriverRemoved,                 
            Type_ControllerCommand,             
            Type_NodeReset                      
        };

        enum NotificationCode
        {
            Code_MsgComplete = 0,           
            Code_Timeout,                   
            Code_NoOperation,               
            Code_Awake,                     
            Code_Sleep,                     
            Code_Dead,                      
            Code_Alive                      
        };

        NotificationType GetType()const{ return m_type; }

        uint32 GetHomeId()const{ return m_valueId.GetHomeId(); }

        uint8 GetNodeId()const{ return m_valueId.GetNodeId(); }

        ValueID const& GetValueID()const{ return m_valueId; }

        uint8 GetGroupIdx()const{ assert(Type_Group==m_type); return m_byte; }

        uint8 GetEvent()const{ assert((Type_NodeEvent==m_type) || (Type_ControllerCommand == m_type)); return m_event; }

        uint8 GetButtonId()const{ assert(Type_CreateButton==m_type || Type_DeleteButton==m_type || Type_ButtonOn==m_type || Type_ButtonOff==m_type); return m_byte; }

        uint8 GetSceneId()const{ assert(Type_SceneEvent==m_type); return m_byte; }

        uint8 GetNotification()const{ assert((Type_Notification==m_type) || (Type_ControllerCommand == m_type)); return m_byte; }

        uint8 GetByte()const{ return m_byte; }

        string GetAsString()const;
 
 
    private:
        Notification( NotificationType _type ): m_type( _type ), m_byte(0), m_event(0) {}
        ~Notification(){}
 
        void SetHomeAndNodeIds( uint32 const _homeId, uint8 const _nodeId ){ m_valueId = ValueID( _homeId, _nodeId ); }
        void SetHomeNodeIdAndInstance ( uint32 const _homeId, uint8 const _nodeId, uint32 const _instance ){ m_valueId = ValueID( _homeId, _nodeId, _instance ); }
        void SetValueId( ValueID const& _valueId ){ m_valueId = _valueId; }
        void SetGroupIdx( uint8 const _groupIdx ){ assert(Type_Group==m_type); m_byte = _groupIdx; }
        void SetEvent( uint8 const _event ){ assert(Type_NodeEvent==m_type || Type_ControllerCommand == m_type); m_event = _event; }
        void SetSceneId( uint8 const _sceneId ){ assert(Type_SceneEvent==m_type); m_byte = _sceneId; }
        void SetButtonId( uint8 const _buttonId ){ assert(Type_CreateButton==m_type||Type_DeleteButton==m_type||Type_ButtonOn==m_type||Type_ButtonOff==m_type); m_byte = _buttonId; }
        void SetNotification( uint8 const _noteId ){ assert((Type_Notification==m_type) || (Type_ControllerCommand == m_type)); m_byte = _noteId; }
 
        NotificationType        m_type;
        ValueID             m_valueId;
        uint8               m_byte;
        uint8               m_event;
    };
 
} //namespace OpenZWave
 
#endif //_Notification_H