File content as of revision 53:7b65422d7a32:

/**
   @file
   @brief Class to provide an abstract representation of a remote
          XBee device's AT command interface
      
   @author John Bailey 

   @copyright Copyright 2014 John Bailey

   @section LICENSE
   
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.

*/

#if !defined XBEEDEVICEREMOTEAT_HPP
#define      XBEEDEVICEREMOTEAT_HPP

#include "XBeeApiCfg.hpp"
#include "XBeeApiFrame.hpp"
#include "XBeeApiCmdAt.hpp"

/** Class used to provide a command interface to a remove XBee via the Remote AT interface.
    The class inherits from XBeeApiCmdAt, hence the interface for the local and remote
    XBees is generally the same.
*/
class XBeeDeviceRemoteAt : public XBeeApiCmdAt
{
    protected:
        /** Called by XBeeDevice in order to offer frame data to the object for
            decoding
           
            \param p_data Pointer to the content of the received data
            \param p_len Length of the data pointed to by p_data
        */
        virtual bool decodeCallback( const uint8_t* const p_data, size_t p_len );

        /* TODO: doc */
        virtual void SendCmd_uint8_t( const uint8_t        p_frameId,
                                      const uint8_t* const p_data,
                                      const uint8_t&       p_val );
        /* TODO: doc */
        virtual void SendCmd_uint16_t( const uint8_t        p_frameId,
                                       const uint8_t* const p_data,
                                       const uint16_t&       p_val );
        /* TODO: doc */
        virtual void SendCmd_uint32_t( const uint8_t        p_frameId,
                                       const uint8_t* const p_data,
                                       const uint32_t&       p_val );
        /* TODO: doc */
        virtual void SendReq( const uint8_t             p_frameId,
                              const uint8_t*            p_data );

        /* TODO: doc */
        virtual size_t getResponseStatusPos( void ) const;

        /** Keep track of whether we're applying changes when the AT command is sent
            or not */
        bool     m_applyChanges;

    public:
    
        /* TODO: doc */
        /** Constructor */
        XBeeDeviceRemoteAt( XBeeDevice* p_device,
                            const uint16_t& p_addr16Bit,
                            const uint64_t& p_addr64Bit = 0,
                            const bool      p_applyChanges = false );
        
        /** Destructor */
        virtual ~XBeeDeviceRemoteAt( void ); 
        
        /** Control whether or not changes are applied when the command is sent or not.
            There are three possibilities for appling changes on the remote:
            1) Use this method, specifying a 'true' parameter so that changes are applied as soon as a command is sent
            2) Use requestApplyChanges() to apply all pending changes
            3) Use requestWriteSettings() followed by requestReset() to write the settings to non-volatile memory and reset the device
        
            \param Specified whether or not the settings should be applied when the command is sent to the remote device */
        void setApplyChanges( const bool p_apply );
};

#endif