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 <Fw/Comp/QueuedComponentBase.hpp>
#include <Os/Task.hpp>
#include <FpConfig.hpp>
#include <Fw/Deprecate.hpp>
 
namespace Fw {
    class ActiveComponentBase : public QueuedComponentBase {
        public:
            void start(NATIVE_UINT_TYPE priority = Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE stackSize = Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE cpuAffinity = Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE identifier = Os::Task::TASK_DEFAULT); 
 
            DEPRECATED(void start(NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity = -1),
                       "Please switch to start(NATIVE_UINT_TYPE priority, NATIVE_UINT_TYPE stackSize, NATIVE_UINT_TYPE cpuAffinity, NATIVE_UINT_TYPE identifier)"); 
            void exit(void); 
            Os::Task::TaskStatus join(void **value_ptr); 
 
            enum {
                ACTIVE_COMPONENT_EXIT 
            };
 
        PROTECTED:
            ActiveComponentBase(const char* name); 
            virtual ~ActiveComponentBase(); 
            void init(NATIVE_INT_TYPE instance); 
            virtual void preamble(void); 
            virtual void loop(void); 
            virtual void finalizer(void); 
            Os::Task m_task; 
#if FW_OBJECT_TO_STRING == 1
            virtual void toString(char* str, NATIVE_INT_TYPE size); 
#endif
        PRIVATE:
            static void s_baseTask(void*); 
            static void s_baseBareTask(void*); 
    };
 
}
#endif