libGizmod/Gizmo.hpp

Go to the documentation of this file.

/*
  
  Copyright (c) 2007, Tim Burrell
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at 

        http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and 
  limitations under the License. 
  
*/

#ifndef __Gizmo_h
#define __Gizmo_h

#if HAVE_CONFIG_H
#include "config.h"
#endif

#include "GizmoEvent.hpp"
#include "GizmoKeyDefs.hpp"
#include "../libH/FileEventWatcher.hpp"
#include <string>
#include <boost/archive/text_oarchive.hpp>
#include <boost/archive/text_iarchive.hpp>
#include <boost/serialization/base_object.hpp>

// Namespace

namespace Gizmod {

// Typedef, enum's

typedef enum {
        GIZMO_CLASS_ATIX10,
        GIZMO_CLASS_LIRC,
        GIZMO_CLASS_POWERMATE,
        GIZMO_CLASS_STANDARD
} GizmoClass;
        
// Class Definition

class Gizmo : public H::DeviceInfo {
public:
        // public functions
        virtual GizmoClass              getClass();                     
        int                             getDeviceID();                  
        int                             getDeviceClassID();             
        virtual int                     getKeyState(GizmoKey Key);      
        virtual std::string             getType();                      
        virtual bool                    processEvent(GizmoEvent * pEvent); 
        void                            setKeyState(GizmoKey Key, int State); 
        
        // construction / deconstruction
        Gizmo();                                                        
        Gizmo(GizmoClass Class, const H::DeviceInfo & deviceInfo, int DeviceID, int DeviceClassID); 
        virtual ~Gizmo();                                               

protected:
        // protected functions
        
        // protected member variables
        GizmoClass                      mClass;                         
        int                             mDeviceID;                      
        int                             mDeviceClassID;                 
        int                             mKeyState[GIZMO_KEY_MAX];       
        
private:
        // private functions
        
        // private member variables
        
private: 
        // serialization
        friend class boost::serialization::access;
        template<class Archive>
        void serialize(Archive & ar, const unsigned int version) {
                ar & boost::serialization::base_object<H::DeviceInfo>(*this);
                ar & mClass;
                ar & mDeviceID;
                ar & mDeviceClassID;
                ar & mKeyState;
        }       
};


} // Gizmod namespace

#endif // __Gizmo_h

---