ActiveComponentBase.hpp

Go to the documentation of this file.

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

/*
 * Description:
 */
#ifndef FW_ACTIVE_COMPONENT_BASE_HPP
#define FW_ACTIVE_COMPONENT_BASE_HPP

#include <FpConfig.hpp>
#include <Fw/Comp/QueuedComponentBase.hpp>
#include <Fw/Deprecate.hpp>
#include <Os/Task.hpp>

namespace Fw {
class ActiveComponentBase : public QueuedComponentBase {
  public:
    void start(Os::Task::ParamType priority = Os::Task::TASK_DEFAULT,
               Os::Task::ParamType stackSize = Os::Task::TASK_DEFAULT,
               Os::Task::ParamType cpuAffinity = Os::Task::TASK_DEFAULT,
               Os::Task::ParamType identifier =
               Os::Task::TASK_DEFAULT);           
    void exit();                                  
    Os::Task::Status join();  
    DEPRECATED(Os::Task::Status join(void** value_ptr), "Switch to .join()");  

    enum {
        ACTIVE_COMPONENT_EXIT  
    };

  PROTECTED:
    enum Lifecycle {
        CREATED,     
        DISPATCHING, 
        FINALIZING, 
        DONE,       
    };

    explicit ActiveComponentBase(const char* name);  
    virtual ~ActiveComponentBase();                  
    void init(FwEnumStoreType instance);             
    virtual void preamble();   
    MsgDispatchStatus dispatch(); 
    virtual void finalizer();  
    Os::Task m_task;           

#if FW_OBJECT_TO_STRING == 1
    virtual const char* getToStringFormatString(); 
#endif
  PRIVATE:
    Lifecycle m_stage;         
    static void s_taskStateMachine(void*); 
    static void s_taskLoop(void*);  
};

}  // namespace Fw
#endif