HealthComponentImpl.hpp

Go to the documentation of this file.

// ======================================================================
// \title  Health.hpp
// \author Tim, J.Perez
// \brief  hpp file for Health component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef Health_HPP
#define Health_HPP

#include <Svc/Health/HealthComponentAc.hpp>
#include <Fw/Types/String.hpp>

namespace Svc {


    class HealthImpl final : public HealthComponentBase {

        public:
            struct PingEntry {
                FwSizeType warnCycles; 
                FwSizeType fatalCycles; 
                Fw::String entryName; 
            };

            HealthImpl(const char * const compName);

            void init(const FwSizeType queueDepth, const FwEnumStoreType instance);

            void setPingEntries(PingEntry* pingEntries, FwIndexType numPingEntries, U32 watchDogCode);

            ~HealthImpl();

        PROTECTED:

            virtual void doOtherChecks();

        PRIVATE:

            void PingReturn_handler(const FwIndexType portNum, U32 key);

            void Run_handler(const FwIndexType portNum, U32 context);

            void HLTH_ENABLE_cmdHandler(const FwOpcodeType opCode, U32 cmdSeq, Fw::Enabled enable);

            void HLTH_PING_ENABLE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg& entry, Fw::Enabled enable);

            void HLTH_CHNG_PING_cmdHandler(const FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg& entry, U32 warningValue, U32 fatalValue);

            struct PingTracker {
                PingEntry entry; 
                U32 cycleCount; 
                U32 key; 
                Fw::Enabled::t enabled; 
            } m_pingTrackerEntries[NUM_PINGSEND_OUTPUT_PORTS];

            FwIndexType findEntry(const Fw::CmdStringArg& entry);

            FwIndexType m_numPingEntries; 
            U32 m_key; 
            U32 m_watchDogCode; 
            U32 m_warnings; 
            Fw::Enabled m_enabled; 
            FwSizeType queue_depth; 

    };

} // end namespace Svc

#endif