UartFramer.hpp

Go to the documentation of this file.

// ======================================================================
// \title  UartFramer.hpp
// \author tcanham
// \brief  hpp file for UartFramer component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef UartFramer_HPP
#define UartFramer_HPP
 
#include "Drv/UartFramer/UartFramerComponentAc.hpp"
 
namespace Drv {
 
  class UartFramer :
    public UartFramerComponentBase
  {
 
    public:
 
      // ----------------------------------------------------------------------
      // Construction, initialization, and destruction
      // ----------------------------------------------------------------------
 
      UartFramer(
          const char *const compName 
      );
 
      void init(
          const NATIVE_INT_TYPE instance = 0 
      );
 
      ~UartFramer();
 
 
      //  instances must be connected and ready. BufferManager should have at least
      //  number+1 buffers allocated
      void allocate(NATIVE_UINT_TYPE number, NATIVE_UINT_TYPE size);
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Handler implementations for user-defined typed input ports
      // ----------------------------------------------------------------------
 
      Drv::SendStatus Framer_handler(
          const NATIVE_INT_TYPE portNum, 
          Fw::Buffer &sendBuffer 
      );
 
      void serialRecv_handler(
          const NATIVE_INT_TYPE portNum, 
          Fw::Buffer &serBuffer, 
          Drv::SerialReadStatus &status 
      );
 
      // Private data members
 
      NATIVE_UINT_TYPE m_size; 
 
 
    };
 
} // end namespace Drv
 
#endif