QueuedComponentBase.hpp

Go to the documentation of this file.

/*
 * ActiveComponentBase.hpp
 *
 *  Created on: Aug 14, 2012
 *      Author: tcanham
 */

/*
 * Description:
 */
#ifndef FW_QUEUED_COMPONENT_BASE_HPP
#define FW_QUEUED_COMPONENT_BASE_HPP

#include <Fw/Comp/PassiveComponentBase.hpp>
#include <Os/Queue.hpp>
#include <Os/Task.hpp>
#include <FpConfig.hpp>


namespace Fw {
    class QueuedComponentBase : public PassiveComponentBase {
        public:

            // Note: Had to make MsgDispatchStatus public for LLVM.
            typedef enum {
                MSG_DISPATCH_OK, 
                MSG_DISPATCH_EMPTY, 
                MSG_DISPATCH_ERROR, 
                MSG_DISPATCH_EXIT 
            } MsgDispatchStatus;

        PROTECTED:
            QueuedComponentBase(const char* name); 
            virtual ~QueuedComponentBase(); 
            void init(FwEnumStoreType instance); 
            Os::Queue m_queue; 
            Os::Queue::Status createQueue(FwSizeType depth, FwSizeType msgSize);
            virtual MsgDispatchStatus doDispatch()=0; 
#if FW_OBJECT_TO_STRING == 1
            virtual const char* getToStringFormatString(); 
#endif
            FwSizeType getNumMsgsDropped(); 
            void incNumMsgDropped(); 
        PRIVATE:
            FwSizeType m_msgsDropped; 
    };

}
#endif