ActiveTextLogger.hpp

Go to the documentation of this file.

// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.


#ifndef ACTIVETEXTLOGGERIMPL_HPP_
#define ACTIVETEXTLOGGERIMPL_HPP_

#include <Svc/ActiveTextLogger/ActiveTextLoggerComponentAc.hpp>
#include <Svc/ActiveTextLogger/LogFile.hpp>


namespace Svc {


    class ActiveTextLogger final : public ActiveTextLoggerComponentBase {

        friend class ActiveTextLoggerTester;

        public:

            explicit ActiveTextLogger(const char* compName);

            virtual ~ActiveTextLogger(); 

            bool set_log_file(const char* fileName, const U32 maxSize, const U32 maxBackups = 10);


        private:

        // ----------------------------------------------------------------------
        // Prohibit Copying
        // ----------------------------------------------------------------------

        ActiveTextLogger(const ActiveTextLogger&);

        ActiveTextLogger& operator=(const ActiveTextLogger&);

        // ----------------------------------------------------------------------
        // Constants/Types
        // ----------------------------------------------------------------------

        // ----------------------------------------------------------------------
        // Member Functions
        // ----------------------------------------------------------------------

        // ----------------------------------------------------------------------
        // Handlers to implement for typed input ports
        // ----------------------------------------------------------------------

        //
        virtual void TextLogger_handler(
            FwIndexType portNum, 
            FwEventIdType id, 
            Fw::Time &timeTag, 
            const Fw::LogSeverity& severity, 
            Fw::TextLogString &text 
        );

        // ----------------------------------------------------------------------
        // Internal interface handlers
        // ----------------------------------------------------------------------

        virtual void TextQueue_internalInterfaceHandler(
            const Fw::InternalInterfaceString& text 
        );

        // ----------------------------------------------------------------------
        // Member Variables
        // ----------------------------------------------------------------------

        // The optional file to text logs to:
        LogFile m_log_file;

    };

}
#endif /* ACTIVETEXTLOGGERIMPL_HPP_ */