Library to easily communicate with XBee modules.

Fork of XBeeLib by Digi International Inc.

FrameHandlers/FH_IoDataSampleDM.h

Committer:
hbujanda
Date:
2016-07-28
Revision:
6:06522f3a6642

File content as of revision 6:06522f3a6642:

/**
 * Copyright (c) 2015 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
 * =======================================================================
 */

#if !defined(__FH_IO_DATA_SAMPLE_DM_H_)
#define __FH_IO_DATA_SAMPLE_DM_H_

#include "FrameHandler.h"
#include "RemoteXBee/RemoteXBee.h"

namespace XBeeLib {

class IOSampleDM;

/**
 * @defgroup callback_types "Callback types declaration"
 * @{
 */
/** IO Data Sample reception (ZigBee modules) callback type declaration
  * @param remote the remote module that sent the data
  * @param sample_data a referece to an @ref IOSampleDM that can be queried for the IoLines' values
  */
typedef void (*io_data_cb_dm_t)(const RemoteXBeeDM& remote, const IOSampleDM& sample_data);
/**
 * @}
 */

class FH_IoDataSampeDM : public FrameHandler
{
    public:
        /** Class constructor */
        FH_IoDataSampeDM();

        /** Class destructor */
        virtual ~FH_IoDataSampeDM();

        virtual void process_frame_data(const ApiFrame *const frame);

        void register_io_data_cb(io_data_cb_dm_t function);

        void unregister_io_data_cb();

    private:
        /** Callback function, invoked if registered */
        io_data_cb_dm_t io_data_cb;
};

}   /* namespace XBeeLib */

#endif /* __FH_IO_DATA_SAMPLE_DM_H_ */