// File: signalinputdata.h
// Created by: <Jörn Reimerdes>
// Created on: 22.03.2005

/**
 * signalinputdata.h - is part of the iwear-framework
 * @file
 * $Id$
 * $Revision$
 * $Author$
 * $Date$
 *
 * This file is part of The iWear Framework.
 * In particular this file is part of the Framework Input Library
 *
 * The iWear Framework is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by the
 * Free Software Foundation as in version 2 of the License.

 * 
 * The iWear Framework 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 General Public License for
 * more details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * The iWear Framework; if not, write to the Free Software Foundation, Inc., 59
 * Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef __SIGNALINPUTDATA_H
#define __SIGNALINPUTDATA_H

#ifndef __INPUTDATA_H
#include <iwear_input/inputdata.h>
#endif

#ifndef __INPUTENUMS_H
#include <iwear_input/inputenums.h>
#endif

#ifndef __INPUTMODULE_H
#include <iwear_input/inputmodule.h>
#endif

#include <bitset>

namespace iwear {
namespace input {

    /** Stores all signal information which are created by an event.
     */
class SignalInputData : public InputData
{
public: 

    /** The signal which was created. */
    InputSignal signal;

    /** The special type of the SignalInputEvent. */
    SignalInputEventType signal_input_event_type;

    /** Creates a new instance of SignalInputData
     * @note Do not forget to set input_module!
     */
    SignalInputData( void );

    /** Creates a new SignalInputData.
     * Should be used by default since it is necessary that
     * input_module is set.
     * @param input_module The InputModule which created the data
     *  object.
     * @param input_hardware_info Information about the device which
     *  created the data.
     * @param input_signal The value of the input signal.
     * @param signal_input_event_type The key input related type of
     *  the KeyInputEvent.
     */
    SignalInputData( InputModule* input_module, 
		     InputHardwareInfo* input_hardware_info,
		     InputSignal input_signal,
		     SignalInputEventType signal_input_event_type);

    /** Creates a new SignalInputData.
     * Should be used by default since it is necessary that
     * input_module is set.
     * @param input_module The InputModule which created the data
     *  object.
     * @param input_hardware_info Information about the device which
     *  created the data.
     *  the KeyInputEvent.
     */
    SignalInputData( InputModule* input_module, 
		     InputHardwareInfo* input_hardware_info);

    /** Destroys the SignalInputData. */
    ~SignalInputData( void );

    /** A bitset which stores the status of all signal modifiers.
     * These modifieres are undersood like the "Control" or "Shift"
     * modifier of a normal PC keyboard. By default no modifier is
     * selected. 
     * Get the signal modifier status with: 
     * - <code>signal_modifier_status_set[InputSignalModifier]</code>
     */
    bitset<num_InputSignalModifier> signal_modifier_status_set;


protected:

private:

};

} // input
} // iwear

#endif	//__SIGNALINPUTDATA_H