CmdArgBuffer.hpp

Go to the documentation of this file.

/*
 *
 *
 *  Created on: March 1, 2014
 *      Author: T. Canham
 */

/*
 * Description:
 * This object contains the CmdARgBuffer type, used for holding the serialized arguments of commands
 */
#ifndef FW_CMD_ARG_BUFFER_HPP
#define FW_CMD_ARG_BUFFER_HPP

#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/SerIds.hpp>
#include <Fw/Types/Serializable.hpp>

namespace Fw {

class CmdArgBuffer final : public LinearBufferBase {
  public:
    enum {
        SERIALIZED_TYPE_ID = FW_TYPEID_CMD_BUFF,  
        SERIALIZED_SIZE =
            STATIC_SERIALIZED_SIZE(FW_CMD_ARG_BUFFER_MAX_SIZE)  
    };

    CmdArgBuffer(const U8* args, FwSizeType size);       
    CmdArgBuffer();                                      
    CmdArgBuffer(const CmdArgBuffer& other);             
    virtual ~CmdArgBuffer();                             
    CmdArgBuffer& operator=(const CmdArgBuffer& other);  

    DEPRECATED(FwSizeType getBuffCapacity() const, "Use getCapacity() instead");
    FwSizeType getCapacity() const;  

    U8* getBuffAddr();              
    const U8* getBuffAddr() const;  

  private:
    U8 m_bufferData[FW_CMD_ARG_BUFFER_MAX_SIZE];  
};

}  // namespace Fw

#endif